<!DOCTYPE HTML>
<html>
<head>
<title>Contiv API documentation</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="generator" content="https://github.com/raml2html/raml2html 6.3.0">
<link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/styles/default.min.css">
<script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/highlight.min.js"></script><script type="text/javascript">
      $(document).ready(function() {
        $('.page-header pre code, .top-resource-description pre code, .modal-body pre code').each(function(i, block) {
          hljs.highlightBlock(block);
        });

        $('[data-toggle]').click(function() {
          var selector = $(this).data('target') + ' pre code';
          $(selector).each(function(i, block) {
            hljs.highlightBlock(block);
          });
        });

        // open modal on hashes like #_action_get
        $(window).bind('hashchange', function(e) {
          var anchor_id = document.location.hash.substr(1); //strip #
          var element = $('#' + anchor_id);

          // do we have such element + is it a modal?  --> show it
          if (element.length && element.hasClass('modal')) {
            element.modal('show');
          }
        });

        // execute hashchange on first page load
        $(window).trigger('hashchange');

        // remove url fragment on modal hide
        $('.modal').on('hidden.bs.modal', function() {
          try {
            if (history && history.replaceState) {
                history.replaceState({}, '', '#');
            }
          } catch(e) {}
        });
      });
    </script><style>
      .hljs {
        background: transparent;
      }
      .parent {
        color: #999;
      }
      .list-group-item > .badge {
        float: none;
        margin-right: 6px;
      }
      .panel-title > .methods {
        float: right;
      }
      .badge {
        border-radius: 0;
        text-transform: uppercase;
        width: 70px;
        font-weight: normal;
        color: #f3f3f6;
        line-height: normal;
      }
      .badge_get {
        background-color: #63a8e2;
      }
      .badge_post {
        background-color: #6cbd7d;
      }
      .badge_put {
        background-color: #22bac4;
      }
      .badge_delete {
        background-color: #d26460;
      }
      .badge_patch {
        background-color: #ccc444;
      }
      .list-group, .panel-group {
        margin-bottom: 0;
      }
      .panel-group .panel+.panel-white {
        margin-top: 0;
      }
      .panel-group .panel-white {
        border-bottom: 1px solid #F5F5F5;
        border-radius: 0;
      }
      .panel-white:last-child {
        border-bottom-color: white;
        -webkit-box-shadow: none;
        box-shadow: none;
      }
      .panel-white .panel-heading {
        background: white;
      }
      .tab-pane ul {
        padding-left: 2em;
      }
      .tab-pane h1 {
        font-size: 1.3em;
      }
      .tab-pane h2 {
        font-size: 1.2em;
        padding-bottom: 4px;
        border-bottom: 1px solid #ddd;
      }
      .tab-pane h3 {
        font-size: 1.1em;
      }
      .tab-content {
        border-left: 1px solid #ddd;
        border-right: 1px solid #ddd;
        border-bottom: 1px solid #ddd;
        padding: 10px;
      }
      #sidebar {
        margin-top: 30px;
        padding-right: 5px;
        overflow: auto;
        height: 90%;
      }
      .top-resource-description {
        border-bottom: 1px solid #ddd;
        background: #fcfcfc;
        padding: 15px 15px 0 15px;
        margin: -15px -15px 10px -15px;
      }
      .resource-description {
        border-bottom: 1px solid #fcfcfc;
        background: #fcfcfc;
        padding: 15px 15px 0 15px;
        margin: -15px -15px 10px -15px;
      }
      .resource-description p:last-child {
        margin: 0;
      }
      .list-group .badge {
        float: left;
      }
      .method_description {
        margin-left: 85px;
      }
      .method_description p:last-child {
        margin: 0;
      }
      .list-group-item {
        cursor: pointer;
      }
      .list-group-item:hover {
        background-color: #f5f5f5;
      }
      pre code {
        overflow: auto;
        word-wrap: normal;
        white-space: pre;
      }
      .items {
        background: #f5f5f5;
        color: #333;
        border: 1px solid #ccc;
        border-radius: 4px;
        padding: 9.5px;
        margin: 0 0 10px;
        font-size: 13px;
        line-height: 1.42857143;
      }
      .examples {
        margin-left: 0.5em;
      }
      .resource-modal li > ul {
        margin-bottom: 1em;
      }
    </style>
<link rel="shortcut icon" href="/assets/images/favicon.png">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
</head>
<body data-spy="scroll" data-target="#sidebar">
<div class="navbar-jumbotron">
  <nav class="navbar navbar-inverse navbar-static-top" role="navigation">
    <div class="container">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="/" style="color:$white"> Contiv </a>
      </div>
      <div class="collapse navbar-collapse" id="navbar">
        <ul class="nav navbar-nav navbar-right main-nav">
          <li><a href="/documents/">Docs</a></li>
          <li><a href="https://github.com/contiv/install/releases">Download</a></li>
          <li><a href="/documents/support/index.html">Support</a></li>
          <li><a href="http://blogs.cisco.com/contiv">Blog</a></li>

          <li><a href="https://github.com/contiv" target="_blank"><i class="fa fa-github" style="color:$white"></i></a></li>
          <li><a href="https://contiv.herokuapp.com" target="_blank"><i class="fa fa-slack" style="color:$white"></i></a></li>
        </ul>
      </div>
    </div>
  </nav>
</div>
<div class="container"><div class="row">
<div class="col-md-9" role="main">
<div class="page-header">
<h1>Contiv API documentation <small>version v1</small>
</h1>
<p>https://{serverfqdn}:10000/api/{version}</p>
<p>Contiv API Specification</p>
<ul>
<li>
<strong>serverfqdn</strong>: <em>required (string)</em>
</li>
<li>
<strong>version</strong>: <em>required (v1)</em>
</li>
</ul>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="auth_proxy" class="panel-title">Auth API</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>Authentication/Authorization related API</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_auth_proxy_health"><span class="parent">/auth_proxy</span>/health/</a> <span class="methods"><a href="#auth_proxy_health_get"><span class="badge badge_get">get</span></a></span>
</h4></div>
<div id="panel_auth_proxy_health" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#auth_proxy_health_get'" class="list-group-item">
<span class="badge badge_get">get</span><div class="method_description"><p>Returns the health status of Contiv API server and its netmaster</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_health_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get</span> <span class="parent">/auth_proxy</span>/health/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns the health status of Contiv API server and its netmaster</p></div>
<ul class="nav nav-tabs"><li class="active"><a href="#auth_proxy_health_get_response" data-toggle="tab">Response</a></li></ul>
<div class="tab-content"><div class="tab-pane active" id="auth_proxy_health_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>status</strong>: <em>required (one of healthy, unhealthy)</em>
</li>
<li>
<strong>version</strong>: <em>required (string)</em>
</li>
<li>
<strong>netmaster</strong>: <em>required (object)</em><ul>
<li>
<strong>status</strong>: <em>required (one of healthy, unhealthy)</em>
</li>
<li>
<strong>reason</strong>: <em>(string)</em><p>reason for netmaster being unhealthy</p>
</li>
<li>
<strong>version</strong>: <em>(string)</em><p>omitted in case netmaster is unhealthy</p>
</li>
</ul>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>{"netmaster":{"status":"healthy","version":"1.0.0"},"status":"healthy","version":"1.0.0"}
</code></pre></div>
</div></div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_auth_proxy_login"><span class="parent">/auth_proxy</span>/login/</a> <span class="methods"><a href="#auth_proxy_login_post"><span class="badge badge_post">post</span></a></span>
</h4></div>
<div id="panel_auth_proxy_login" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#auth_proxy_login_post'" class="list-group-item">
<span class="badge badge_post">post</span><div class="method_description"><p>Login to Contiv API server</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_login_post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post</span> <span class="parent">/auth_proxy</span>/login/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Login to Contiv API server</p></div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_login_post_request" data-toggle="tab">Request</a></li>
<li><a href="#auth_proxy_login_post_response" data-toggle="tab">Response</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_login_post_request">
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>username</strong>: <em>required (string)</em><p>username. If a local user doesn't exist by that name, AD authentication will be tried using sAMAccountName=username in BaseDN scope of the AD server (see ldap configuration for more details)</p>
</li>
<li>
<strong>password</strong>: <em>required (string)</em>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>{
  "username": "johndoe",
  "password": "p@ssw0rd"
}</code></pre></div>
</div>
<div class="tab-pane" id="auth_proxy_login_post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul><li>
<strong>token</strong>: <em>required (string)</em><p>opaque token string, callers should set custom security header to this token before calling further APIs (see security information for protected APIs)</p>
</li></ul>
<h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a>
</h2>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_auth_proxy_version"><span class="parent">/auth_proxy</span>/version/</a> <span class="methods"><a href="#auth_proxy_version_get"><span class="badge badge_get">get</span></a></span>
</h4></div>
<div id="panel_auth_proxy_version" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#auth_proxy_version_get'" class="list-group-item">
<span class="badge badge_get">get</span><div class="method_description"><p>Returns the Contiv API server version</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_version_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get</span> <span class="parent">/auth_proxy</span>/version/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns the Contiv API server version</p></div>
<ul class="nav nav-tabs"><li class="active"><a href="#auth_proxy_version_get_response" data-toggle="tab">Response</a></li></ul>
<div class="tab-content"><div class="tab-pane active" id="auth_proxy_version_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{ "version": "1.0.0" }
</code></pre>
</div></div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_auth_proxy_authorizations"><span class="parent">/auth_proxy</span>/authorizations/</a> <span class="methods"><a href="#auth_proxy_authorizations_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#auth_proxy_authorizations_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_auth_proxy_authorizations" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>A collection of authorizations</p></div>
<div class="list-group">
<div onclick="window.location.href = '#auth_proxy_authorizations_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of authorizations.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#auth_proxy_authorizations_post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Create a new authorization.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_authorizations_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy</span>/authorizations/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of authorizations.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_authorizations_get_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_authorizations_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_authorizations_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of authorization</p>
<p><strong>Items</strong>: authorization</p>
<div class="items"><ul>
<li>
<strong>principalName</strong>: <em>required (string)</em>
</li>
<li>
<strong>local</strong>: <em>required (boolean)</em>
</li>
<li>
<strong>role</strong>: <em>required (string)</em>
</li>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
</ul></div>
</div>
<div class="tab-pane" id="auth_proxy_authorizations_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_authorizations_post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy</span>/authorizations/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Create a new authorization.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_authorizations_post_request" data-toggle="tab">Request</a></li>
<li><a href="#auth_proxy_authorizations_post_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_authorizations_post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_authorizations_post_request">
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>principalName</strong>: <em>required (string)</em>
</li>
<li>
<strong>local</strong>: <em>required (boolean)</em>
</li>
<li>
<strong>role</strong>: <em>required (string)</em>
</li>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>{
  "principalName": "johndoe",
  "local": true,
  "role": "ops",
  "tenantName": "johnstenant"
}</code></pre></div>
</div>
<div class="tab-pane" id="auth_proxy_authorizations_post_response">
<h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="auth_proxy_authorizations_post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_auth_proxy_authorizations__authzuuid_"><span class="parent">/auth_proxy/authorizations</span>/{authzUUID}/</a> <span class="methods"><a href="#auth_proxy_authorizations__authzuuid__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#auth_proxy_authorizations__authzuuid__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_auth_proxy_authorizations__authzuuid_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing authorization</p></div>
<div class="list-group">
<div onclick="window.location.href = '#auth_proxy_authorizations__authzuuid__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a authorization.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#auth_proxy_authorizations__authzuuid__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a authorization.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_authorizations__authzuuid__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy/authorizations</span>/{authzUUID}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a authorization.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_authorizations__authzuuid__get_request" data-toggle="tab">Request</a></li>
<li><a href="#auth_proxy_authorizations__authzuuid__get_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_authorizations__authzuuid__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_authorizations__authzuuid__get_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>authzUUID</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="auth_proxy_authorizations__authzuuid__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>principalName</strong>: <em>required (string)</em>
</li>
<li>
<strong>local</strong>: <em>required (boolean)</em>
</li>
<li>
<strong>role</strong>: <em>required (string)</em>
</li>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>{
  "principalName": "johndoe",
  "local": true,
  "role": "ops",
  "tenantName": "johnstenant"
}</code></pre></div>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "authorization not found" }
</code></pre>
</div>
<div class="tab-pane" id="auth_proxy_authorizations__authzuuid__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_authorizations__authzuuid__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy/authorizations</span>/{authzUUID}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a authorization.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_authorizations__authzuuid__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#auth_proxy_authorizations__authzuuid__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_authorizations__authzuuid__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_authorizations__authzuuid__delete_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>authzUUID</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="auth_proxy_authorizations__authzuuid__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a>
</h2></div>
<div class="tab-pane" id="auth_proxy_authorizations__authzuuid__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_auth_proxy_local_users"><span class="parent">/auth_proxy</span>/local_users/</a> <span class="methods"><a href="#auth_proxy_local_users_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#auth_proxy_local_users_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_auth_proxy_local_users" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>A collection of local_users</p></div>
<div class="list-group">
<div onclick="window.location.href = '#auth_proxy_local_users_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of local_users.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#auth_proxy_local_users_post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Create a new local_user.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_local_users_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy</span>/local_users/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of local_users.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_local_users_get_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_local_users_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_local_users_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of local_user</p>
<p><strong>Items</strong>: local_user</p>
<div class="items"><ul>
<li>
<strong>username</strong>: <em>required (string)</em>
</li>
<li>
<strong>password</strong>: <em>required (string)</em>
</li>
<li>
<strong>firstname</strong>: <em>(string)</em><p><strong>Example</strong>:</p>
<div class="examples"><pre><code>John</code></pre></div>
</li>
<li>
<strong>lastname</strong>: <em>(string)</em><p><strong>Example</strong>:</p>
<div class="examples"><pre><code>Doe</code></pre></div>
</li>
<li>
<strong>disable</strong>: <em>(boolean)</em>
</li>
</ul></div>
</div>
<div class="tab-pane" id="auth_proxy_local_users_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_local_users_post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy</span>/local_users/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Create a new local_user.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_local_users_post_request" data-toggle="tab">Request</a></li>
<li><a href="#auth_proxy_local_users_post_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_local_users_post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_local_users_post_request">
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>username</strong>: <em>required (string)</em>
</li>
<li>
<strong>password</strong>: <em>required (string)</em>
</li>
<li>
<strong>firstname</strong>: <em>(string)</em><p><strong>Example</strong>:</p>
<div class="examples"><pre><code>John</code></pre></div>
</li>
<li>
<strong>lastname</strong>: <em>(string)</em><p><strong>Example</strong>:</p>
<div class="examples"><pre><code>Doe</code></pre></div>
</li>
<li>
<strong>disable</strong>: <em>(boolean)</em>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>{
  "username": "johndoe",
  "password": "p@ssw0rd"
}</code></pre></div>
</div>
<div class="tab-pane" id="auth_proxy_local_users_post_response">
<h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="auth_proxy_local_users_post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_auth_proxy_local_users__username_"><span class="parent">/auth_proxy/local_users</span>/{username}/</a> <span class="methods"><a href="#auth_proxy_local_users__username__patch"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#auth_proxy_local_users__username__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#auth_proxy_local_users__username__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_auth_proxy_local_users__username_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing local_user</p></div>
<div class="list-group">
<div onclick="window.location.href = '#auth_proxy_local_users__username__patch'" class="list-group-item">
<span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates part of a local_user</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#auth_proxy_local_users__username__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a local_user.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#auth_proxy_local_users__username__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a local_user.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_local_users__username__patch"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy/local_users</span>/{username}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates part of a local_user</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_local_users__username__patch_request" data-toggle="tab">Request</a></li>
<li><a href="#auth_proxy_local_users__username__patch_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_local_users__username__patch_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_local_users__username__patch_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>username</strong>: <em>required (string)</em>
</li></ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>firstname</strong>: <em>(string)</em>
</li>
<li>
<strong>lastname</strong>: <em>(string)</em>
</li>
<li>
<strong>disable</strong>: <em>(boolean)</em>
</li>
<li>
<strong>password</strong>: <em>(string)</em>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>{
  "firstname": "Jane",
  "disable": true
}</code></pre></div>
</div>
<div class="tab-pane" id="auth_proxy_local_users__username__patch_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>username</strong>: <em>required (string)</em>
</li>
<li>
<strong>password</strong>: <em>required (string)</em>
</li>
<li>
<strong>firstname</strong>: <em>(string)</em><p><strong>Example</strong>:</p>
<div class="examples"><pre><code>John</code></pre></div>
</li>
<li>
<strong>lastname</strong>: <em>(string)</em><p><strong>Example</strong>:</p>
<div class="examples"><pre><code>Doe</code></pre></div>
</li>
<li>
<strong>disable</strong>: <em>(boolean)</em>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>{
  "username": "johndoe",
  "password": "p@ssw0rd"
}</code></pre></div>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "local_user not found" }
</code></pre>
</div>
<div class="tab-pane" id="auth_proxy_local_users__username__patch_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_local_users__username__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy/local_users</span>/{username}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a local_user.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_local_users__username__get_request" data-toggle="tab">Request</a></li>
<li><a href="#auth_proxy_local_users__username__get_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_local_users__username__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_local_users__username__get_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>username</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="auth_proxy_local_users__username__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>username</strong>: <em>required (string)</em>
</li>
<li>
<strong>password</strong>: <em>required (string)</em>
</li>
<li>
<strong>firstname</strong>: <em>(string)</em><p><strong>Example</strong>:</p>
<div class="examples"><pre><code>John</code></pre></div>
</li>
<li>
<strong>lastname</strong>: <em>(string)</em><p><strong>Example</strong>:</p>
<div class="examples"><pre><code>Doe</code></pre></div>
</li>
<li>
<strong>disable</strong>: <em>(boolean)</em>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>{
  "username": "johndoe",
  "password": "p@ssw0rd"
}</code></pre></div>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "local_user not found" }
</code></pre>
</div>
<div class="tab-pane" id="auth_proxy_local_users__username__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_local_users__username__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy/local_users</span>/{username}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a local_user.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_local_users__username__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#auth_proxy_local_users__username__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_local_users__username__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_local_users__username__delete_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>username</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="auth_proxy_local_users__username__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a>
</h2></div>
<div class="tab-pane" id="auth_proxy_local_users__username__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_auth_proxy_ldap_configuration"><span class="parent">/auth_proxy</span>/ldap_configuration/</a> <span class="methods"><a href="#auth_proxy_ldap_configuration_put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#auth_proxy_ldap_configuration_patch"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#auth_proxy_ldap_configuration_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#auth_proxy_ldap_configuration_delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_auth_proxy_ldap_configuration" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing ldap_configuration</p></div>
<div class="list-group">
<div onclick="window.location.href = '#auth_proxy_ldap_configuration_put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a ldap_configuration</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#auth_proxy_ldap_configuration_patch'" class="list-group-item">
<span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates part of a ldap_configuration</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#auth_proxy_ldap_configuration_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a ldap_configuration.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#auth_proxy_ldap_configuration_delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a ldap_configuration.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_ldap_configuration_put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy</span>/ldap_configuration/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a ldap_configuration</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_ldap_configuration_put_request" data-toggle="tab">Request</a></li>
<li><a href="#auth_proxy_ldap_configuration_put_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_ldap_configuration_put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_ldap_configuration_put_request">
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>server</strong>: <em>required (string)</em><p>FQDN or IP address of AD server</p>
</li>
<li>
<strong>port</strong>: <em>required (integer - minimum: 0)</em><p>port where AD server is listening</p>
</li>
<li>
<strong>base_dn</strong>: <em>required (string)</em><p>Distinguished name for base entity. All search queries will be scope to this BaseDN</p>
</li>
<li>
<strong>service_account_dn</strong>: <em>required (string)</em><p>DN of the service account. auth_proxy will use this account to communicate with AD server. Hence this account must have appropriate privileges, specifically for lookup.</p>
</li>
<li>
<strong>service_account_password</strong>: <em>required (string)</em>
</li>
<li>
<strong>start_tls</strong>: <em>required (boolean)</em><p>switch session to TLS after proxy connects to AD server. This option must be configured on AD server. Recommended to set to true in production environments.</p>
</li>
<li>
<strong>insecure_skip_verify</strong>: <em>required (boolean)</em><p>skip cert check on AD server. Recommended to set to false for production environments.</p>
</li>
</ul>
</div>
<div class="tab-pane" id="auth_proxy_ldap_configuration_put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>server</strong>: <em>required (string)</em><p>FQDN or IP address of AD server</p>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>auth.local.com</code></pre></div>
</li>
<li>
<strong>port</strong>: <em>required (integer - minimum: 0)</em><p>port where AD server is listening</p>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>389</code></pre></div>
</li>
<li>
<strong>base_dn</strong>: <em>required (string)</em><p>Distinguished name for base entity. All search queries will be scope to this BaseDN</p>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>ou=eng,dc=auth,dc=com</code></pre></div>
</li>
<li>
<strong>service_account_dn</strong>: <em>required (string)</em><p>DN of the service account. auth_proxy will use this account to communicate with AD server. Hence this account must have appropriate privileges, specifically for lookup.</p>
</li>
<li>
<strong>service_account_password</strong>: <em>required (string)</em>
</li>
<li>
<strong>start_tls</strong>: <em>required (boolean)</em><p>switch session to TLS after proxy connects to AD server. This option must be configured on AD server. Recommended to set to true in production environments.</p>
</li>
<li>
<strong>insecure_skip_verify</strong>: <em>required (boolean)</em><p>skip cert check on AD server. Recommended to set to false for production environments.</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "ldap_configuration not found" }
</code></pre>
</div>
<div class="tab-pane" id="auth_proxy_ldap_configuration_put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_ldap_configuration_patch"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy</span>/ldap_configuration/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates part of a ldap_configuration</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_ldap_configuration_patch_request" data-toggle="tab">Request</a></li>
<li><a href="#auth_proxy_ldap_configuration_patch_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_ldap_configuration_patch_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_ldap_configuration_patch_request">
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>server</strong>: <em>required (string)</em><p>FQDN or IP address of AD server</p>
</li>
<li>
<strong>port</strong>: <em>required (integer - minimum: 0)</em><p>port where AD server is listening</p>
</li>
<li>
<strong>base_dn</strong>: <em>required (string)</em><p>Distinguished name for base entity. All search queries will be scope to this BaseDN</p>
</li>
<li>
<strong>service_account_dn</strong>: <em>required (string)</em><p>DN of the service account. auth_proxy will use this account to communicate with AD server. Hence this account must have appropriate privileges, specifically for lookup.</p>
</li>
<li>
<strong>service_account_password</strong>: <em>required (string)</em>
</li>
<li>
<strong>start_tls</strong>: <em>required (boolean)</em><p>switch session to TLS after proxy connects to AD server. This option must be configured on AD server. Recommended to set to true in production environments.</p>
</li>
<li>
<strong>insecure_skip_verify</strong>: <em>required (boolean)</em><p>skip cert check on AD server. Recommended to set to false for production environments.</p>
</li>
</ul>
</div>
<div class="tab-pane" id="auth_proxy_ldap_configuration_patch_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>server</strong>: <em>required (string)</em><p>FQDN or IP address of AD server</p>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>auth.local.com</code></pre></div>
</li>
<li>
<strong>port</strong>: <em>required (integer - minimum: 0)</em><p>port where AD server is listening</p>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>389</code></pre></div>
</li>
<li>
<strong>base_dn</strong>: <em>required (string)</em><p>Distinguished name for base entity. All search queries will be scope to this BaseDN</p>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>ou=eng,dc=auth,dc=com</code></pre></div>
</li>
<li>
<strong>service_account_dn</strong>: <em>required (string)</em><p>DN of the service account. auth_proxy will use this account to communicate with AD server. Hence this account must have appropriate privileges, specifically for lookup.</p>
</li>
<li>
<strong>service_account_password</strong>: <em>required (string)</em>
</li>
<li>
<strong>start_tls</strong>: <em>required (boolean)</em><p>switch session to TLS after proxy connects to AD server. This option must be configured on AD server. Recommended to set to true in production environments.</p>
</li>
<li>
<strong>insecure_skip_verify</strong>: <em>required (boolean)</em><p>skip cert check on AD server. Recommended to set to false for production environments.</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "ldap_configuration not found" }
</code></pre>
</div>
<div class="tab-pane" id="auth_proxy_ldap_configuration_patch_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_ldap_configuration_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy</span>/ldap_configuration/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a ldap_configuration.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_ldap_configuration_get_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_ldap_configuration_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_ldap_configuration_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>server</strong>: <em>required (string)</em><p>FQDN or IP address of AD server</p>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>auth.local.com</code></pre></div>
</li>
<li>
<strong>port</strong>: <em>required (integer - minimum: 0)</em><p>port where AD server is listening</p>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>389</code></pre></div>
</li>
<li>
<strong>base_dn</strong>: <em>required (string)</em><p>Distinguished name for base entity. All search queries will be scope to this BaseDN</p>
<p><strong>Example</strong>:</p>
<div class="examples"><pre><code>ou=eng,dc=auth,dc=com</code></pre></div>
</li>
<li>
<strong>service_account_dn</strong>: <em>required (string)</em><p>DN of the service account. auth_proxy will use this account to communicate with AD server. Hence this account must have appropriate privileges, specifically for lookup.</p>
</li>
<li>
<strong>service_account_password</strong>: <em>required (string)</em>
</li>
<li>
<strong>start_tls</strong>: <em>required (boolean)</em><p>switch session to TLS after proxy connects to AD server. This option must be configured on AD server. Recommended to set to true in production environments.</p>
</li>
<li>
<strong>insecure_skip_verify</strong>: <em>required (boolean)</em><p>skip cert check on AD server. Recommended to set to false for production environments.</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "ldap_configuration not found" }
</code></pre>
</div>
<div class="tab-pane" id="auth_proxy_ldap_configuration_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="auth_proxy_ldap_configuration_delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/auth_proxy</span>/ldap_configuration/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a ldap_configuration.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#auth_proxy_ldap_configuration_delete_response" data-toggle="tab">Response</a></li>
<li><a href="#auth_proxy_ldap_configuration_delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="auth_proxy_ldap_configuration_delete_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a>
</h2></div>
<div class="tab-pane" id="auth_proxy_ldap_configuration_delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="inspect" class="panel-title">Inspect</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>Inspect APIs for various Contiv managed objects</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_acigws_acigw"><span class="parent">/inspect/aciGws</span>/aciGw/</a> <span class="methods"><a href="#inspect_acigws_acigw_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_acigws_acigw" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing aciGw</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_acigws_acigw_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a aciGw.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_acigws_acigw_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/aciGws</span>/aciGw/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a aciGw.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_acigws_acigw_get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_acigws_acigw_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_acigws_acigw_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(aciGw)$)</em><p>name of this block(must be 'aciGw')</p>
</li>
<li>
<strong>pathBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])*$)</em><p>List of ACI fabric ports connected to cluster</p>
</li>
<li>
<strong>nodeBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})*$)</em><p>List of ACI complete nodes to be bound</p>
</li>
<li>
<strong>physicalDomain</strong>: <em>required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Name of the physical domain</p>
</li>
<li>
<strong>enforcePolicies</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Enforce security policy</p>
</li>
<li>
<strong>includeCommonTenant</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Include common tenant when searching for objects</p>
</li>
</ul>
</li>
<li>
<strong>Oper</strong>: <em>required (object)</em><ul><li>
<strong>numAppProfiles</strong>: <em>required (integer)</em>
</li></ul>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "aciGw not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_acigws_acigw_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_appprofiles__tenantname___appprofilename_"><span class="parent">/inspect/appProfiles</span>/{tenantName}:{appProfileName}/</a> <span class="methods"><a href="#inspect_appprofiles__tenantname___appprofilename__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_appprofiles__tenantname___appprofilename_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing appProfile</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_appprofiles__tenantname___appprofilename__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a appProfile.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_appprofiles__tenantname___appprofilename__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/appProfiles</span>/{tenantName}:{appProfileName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a appProfile.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_appprofiles__tenantname___appprofilename__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_appprofiles__tenantname___appprofilename__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_appprofiles__tenantname___appprofilename__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_appprofiles__tenantname___appprofilename__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>appProfileName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="inspect_appprofiles__tenantname___appprofilename__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul><li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>appProfileName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Application Profile Name</p>
</li>
<li>
<strong>endpointGroups</strong>: <em>required (array of items)</em><p>Member groups of the appProf</p>
</li>
</ul>
</li></ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "appProfile not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_appprofiles__tenantname___appprofilename__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_bgps__hostname_"><span class="parent">/inspect/Bgps</span>/{hostname}/</a> <span class="methods"><a href="#inspect_bgps__hostname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_bgps__hostname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing Bgp</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_bgps__hostname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a Bgp.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_bgps__hostname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/Bgps</span>/{hostname}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a Bgp.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_bgps__hostname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_bgps__hostname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_bgps__hostname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_bgps__hostname__get_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>hostname</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="inspect_bgps__hostname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>hostname</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>host name</p>
</li>
<li>
<strong>routerip</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Bgp router intf ip</p>
</li>
<li>
<strong>as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor-as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Bgp neighbor</p>
</li>
</ul>
</li>
<li>
<strong>Oper</strong>: <em>required (object)</em><ul>
<li>
<strong>numRoutes</strong>: <em>required (integer)</em><p>number of routes</p>
</li>
<li>
<strong>neighborStatus</strong>: <em>required (string)</em><p>neighbor status</p>
</li>
<li>
<strong>adminStatus</strong>: <em>required (string)</em><p>admin status</p>
</li>
<li>
<strong>routes</strong>: <em>required (array of items)</em><p>routes</p>
</li>
</ul>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "Bgp not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_bgps__hostname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_endpoints__endpointid_"><span class="parent">/inspect/endpoints</span>/{endpointID}/</a> <span class="methods"><a href="#inspect_endpoints__endpointid__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_endpoints__endpointid_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing endpoint</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_endpoints__endpointid__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a endpoint.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_endpoints__endpointid__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/endpoints</span>/{endpointID}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a endpoint.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_endpoints__endpointid__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_endpoints__endpointid__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_endpoints__endpointid__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_endpoints__endpointid__get_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>endpointID</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="inspect_endpoints__endpointid__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>Config</strong>: <em>required (object)</em><ul></ul>
</li>
<li>
<strong>Oper</strong>: <em>required (object)</em><ul>
<li>
<strong>network</strong>: <em>required (string)</em>
</li>
<li>
<strong>endpointID</strong>: <em>required (string)</em>
</li>
<li>
<strong>serviceName</strong>: <em>required (string)</em>
</li>
<li>
<strong>endpointGroupId</strong>: <em>required (integer)</em>
</li>
<li>
<strong>endpointGroupKey</strong>: <em>required (string)</em>
</li>
<li>
<strong>ipAddress</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>macAddress</strong>: <em>required (string)</em>
</li>
<li>
<strong>homingHost</strong>: <em>required (string)</em>
</li>
<li>
<strong>intfName</strong>: <em>required (string)</em>
</li>
<li>
<strong>vtepIP</strong>: <em>required (string)</em>
</li>
<li>
<strong>labels</strong>: <em>required (string)</em>
</li>
<li>
<strong>containerID</strong>: <em>required (string)</em>
</li>
<li>
<strong>containerName</strong>: <em>required (string)</em>
</li>
<li>
<strong>virtualPort</strong>: <em>required (string)</em>
</li>
</ul>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "endpoint not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_endpoints__endpointid__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_endpointgroups__tenantname___groupname_"><span class="parent">/inspect/endpointGroups</span>/{tenantName}:{groupName}/</a> <span class="methods"><a href="#inspect_endpointgroups__tenantname___groupname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_endpointgroups__tenantname___groupname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing endpointGroup</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_endpointgroups__tenantname___groupname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a endpointGroup.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_endpointgroups__tenantname___groupname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/endpointGroups</span>/{tenantName}:{groupName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a endpointGroup.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_endpointgroups__tenantname___groupname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_endpointgroups__tenantname___groupname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_endpointgroups__tenantname___groupname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_endpointgroups__tenantname___groupname__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>groupName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="inspect_endpointgroups__tenantname___groupname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>groupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>ipPool</strong>: <em>required (string - pattern: ^$|^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?$)</em><p>IP-pool</p>
</li>
<li>
<strong>policies</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>extContractsGrps</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>netProfile</strong>: <em>required (string)</em>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em>
</li>
</ul>
</li>
<li>
<strong>Oper</strong>: <em>required (object)</em><ul>
<li>
<strong>pktTag</strong>: <em>required (integer)</em><p>internal packet tag</p>
</li>
<li>
<strong>externalPktTag</strong>: <em>required (integer)</em><p>external packet tag</p>
</li>
<li>
<strong>numEndpoints</strong>: <em>required (integer)</em><p>number of endpoints</p>
</li>
<li>
<strong>endpoints</strong>: <em>required (array of endpoint)</em><p>endpoints in the group</p>
<p><strong>Items</strong>: endpoint</p>
<div class="items"><ul></ul></div>
</li>
<li>
<strong>allocatedIPAddresses</strong>: <em>required (string)</em><p>allocated IP addresses</p>
</li>
<li>
<strong>availableIPAddresses</strong>: <em>required (string)</em><p>Available IP addresses</p>
</li>
<li>
<strong>groupTag</strong>: <em>required (string)</em><p>Derived EndpointGroup Tag</p>
</li>
</ul>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "endpointGroup not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_endpointgroups__tenantname___groupname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_extcontractsgroups__tenantname___contractsgroupname_"><span class="parent">/inspect/extContractsGroups</span>/{tenantName}:{contractsGroupName}/</a> <span class="methods"><a href="#inspect_extcontractsgroups__tenantname___contractsgroupname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_extcontractsgroups__tenantname___contractsgroupname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing extContractsGroup</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_extcontractsgroups__tenantname___contractsgroupname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a extContractsGroup.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_extcontractsgroups__tenantname___contractsgroupname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/extContractsGroups</span>/{tenantName}:{contractsGroupName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a extContractsGroup.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_extcontractsgroups__tenantname___contractsgroupname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_extcontractsgroups__tenantname___contractsgroupname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_extcontractsgroups__tenantname___contractsgroupname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_extcontractsgroups__tenantname___contractsgroupname__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>contractsGroupName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="inspect_extcontractsgroups__tenantname___contractsgroupname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul><li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant name</p>
</li>
<li>
<strong>contractsGroupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Contracts group name</p>
</li>
<li>
<strong>contractsType</strong>: <em>required (string)</em><p>Contracts type</p>
</li>
<li>
<strong>contracts</strong>: <em>required (array of items)</em><p>Contracts list</p>
</li>
</ul>
</li></ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "extContractsGroup not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_extcontractsgroups__tenantname___contractsgroupname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_globals_global"><span class="parent">/inspect/globals</span>/global/</a> <span class="methods"><a href="#inspect_globals_global_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_globals_global" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing global</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_globals_global_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a global.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_globals_global_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/globals</span>/global/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a global.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_globals_global_get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_globals_global_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_globals_global_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(global)$)</em><p>name of this block(must be 'global')</p>
</li>
<li>
<strong>networkInfraType</strong>: <em>required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)</em><p>Network infrastructure type</p>
</li>
<li>
<strong>vlans</strong>: <em>required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)</em><p>Allowed vlan range</p>
</li>
<li>
<strong>vxlans</strong>: <em>required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)</em><p>Allwed vxlan range</p>
</li>
<li>
<strong>fwdMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)</em><p>Forwarding Mode</p>
</li>
<li>
<strong>arpMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)</em><p>ARP Mode</p>
</li>
<li>
<strong>pvtSubnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)</em><p>Private Subnet used by host bridge</p>
</li>
</ul>
</li>
<li>
<strong>Oper</strong>: <em>required (object)</em><ul>
<li>
<strong>numNetworks</strong>: <em>required (integer)</em>
</li>
<li>
<strong>defaultNetwork</strong>: <em>required (string)</em>
</li>
<li>
<strong>vlansInUse</strong>: <em>required (string)</em>
</li>
<li>
<strong>vxlansInUse</strong>: <em>required (string)</em>
</li>
<li>
<strong>freeVXLANsStart</strong>: <em>required (integer)</em>
</li>
<li>
<strong>clusterMode</strong>: <em>required (string)</em>
</li>
</ul>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "global not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_globals_global_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_netprofiles__tenantname___profilename_"><span class="parent">/inspect/netprofiles</span>/{tenantName}:{profileName}/</a> <span class="methods"><a href="#inspect_netprofiles__tenantname___profilename__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_netprofiles__tenantname___profilename_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing netprofile</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_netprofiles__tenantname___profilename__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a netprofile.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_netprofiles__tenantname___profilename__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/netprofiles</span>/{tenantName}:{profileName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a netprofile.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_netprofiles__tenantname___profilename__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_netprofiles__tenantname___profilename__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_netprofiles__tenantname___profilename__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_netprofiles__tenantname___profilename__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>profileName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="inspect_netprofiles__tenantname___profilename__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul><li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>profileName</strong>: <em>required (string - maxLength: 64)</em><p>Network profile name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string)</em><p>Tenant name</p>
</li>
<li>
<strong>bandwidth</strong>: <em>required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)</em><p>Allocated bandwidth</p>
</li>
<li>
<strong>DSCP</strong>: <em>required (integer)</em><p>DSCP</p>
</li>
<li>
<strong>burst</strong>: <em>required (integer)</em><p>burst size</p>
</li>
</ul>
</li></ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "netprofile not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_netprofiles__tenantname___profilename__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_networks__tenantname___networkname_"><span class="parent">/inspect/networks</span>/{tenantName}:{networkName}/</a> <span class="methods"><a href="#inspect_networks__tenantname___networkname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_networks__tenantname___networkname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing network</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_networks__tenantname___networkname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a network.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_networks__tenantname___networkname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/networks</span>/{tenantName}:{networkName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a network.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_networks__tenantname___networkname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_networks__tenantname___networkname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_networks__tenantname___networkname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_networks__tenantname___networkname__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="inspect_networks__tenantname___networkname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>pktTag</strong>: <em>required (integer)</em><p>Vlan/Vxlan Tag</p>
</li>
<li>
<strong>encap</strong>: <em>required (string - pattern: ^(vlan|vxlan)$)</em><p>Encapsulation</p>
</li>
<li>
<strong>ipv6Gateway</strong>: <em>required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)</em><p>IPv6Gateway</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>ipv6Subnet</strong>: <em>required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)</em><p>IPv6Subnet</p>
</li>
<li>
<strong>gateway</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Gateway</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Network name</p>
</li>
<li>
<strong>subnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Subnet</p>
</li>
<li>
<strong>nwType</strong>: <em>required (string - pattern: ^(infra|data)$)</em><p>Network Type</p>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em><p>Configured Network Tag</p>
</li>
</ul>
</li>
<li>
<strong>Oper</strong>: <em>required (object)</em><ul>
<li>
<strong>pktTag</strong>: <em>required (integer)</em><p>internal packet tag</p>
</li>
<li>
<strong>externalPktTag</strong>: <em>required (integer)</em><p>external packet tag</p>
</li>
<li>
<strong>numEndpoints</strong>: <em>required (integer)</em><p>external packet tag</p>
</li>
<li>
<strong>allocatedAddressesCount</strong>: <em>required (integer)</em><p>Vlan/Vxlan Tag</p>
</li>
<li>
<strong>allocatedIPAddresses</strong>: <em>required (string)</em><p>allocated IP addresses</p>
</li>
<li>
<strong>availableIPAddresses</strong>: <em>required (string)</em><p>Available IP addresses</p>
</li>
<li>
<strong>endpoints</strong>: <em>required (array of endpoint)</em><p>endpoints in the network</p>
<p><strong>Items</strong>: endpoint</p>
<div class="items"><ul></ul></div>
</li>
<li>
<strong>networkTag</strong>: <em>required (string)</em><p>Derived Network Tag</p>
</li>
</ul>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "network not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_networks__tenantname___networkname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_policys__tenantname___policyname_"><span class="parent">/inspect/policys</span>/{tenantName}:{policyName}/</a> <span class="methods"><a href="#inspect_policys__tenantname___policyname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_policys__tenantname___policyname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing policy</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_policys__tenantname___policyname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a policy.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_policys__tenantname___policyname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/policys</span>/{tenantName}:{policyName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a policy.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_policys__tenantname___policyname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_policys__tenantname___policyname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_policys__tenantname___policyname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_policys__tenantname___policyname__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>policyName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="inspect_policys__tenantname___policyname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
</ul>
</li>
<li>
<strong>Oper</strong>: <em>required (object)</em><ul>
<li>
<strong>numEndpoints</strong>: <em>required (integer)</em><p>number of endpoints</p>
</li>
<li>
<strong>policyViolations</strong>: <em>required (integer)</em><p>number of policyViolations</p>
</li>
<li>
<strong>endpoints</strong>: <em>required (array of endpoint)</em><p>endpoints associate with the policy</p>
<p><strong>Items</strong>: endpoint</p>
<div class="items"><ul></ul></div>
</li>
</ul>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "policy not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_policys__tenantname___policyname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_rules__tenantname___policyname___ruleid_"><span class="parent">/inspect/rules</span>/{tenantName}:{policyName}:{ruleId}/</a> <span class="methods"><a href="#inspect_rules__tenantname___policyname___ruleid__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_rules__tenantname___policyname___ruleid_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing rule</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_rules__tenantname___policyname___ruleid__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a rule.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_rules__tenantname___policyname___ruleid__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/rules</span>/{tenantName}:{policyName}:{ruleId}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a rule.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_rules__tenantname___policyname___ruleid__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_rules__tenantname___policyname___ruleid__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_rules__tenantname___policyname___ruleid__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_rules__tenantname___policyname___ruleid__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>policyName</strong>: <em>required (string)</em>
</li>
<li>
<strong>ruleId</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="inspect_rules__tenantname___policyname___ruleid__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul><li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>protocol</strong>: <em>required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)</em><p>Protocol</p>
</li>
<li>
<strong>fromEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Endpoint Group</p>
</li>
<li>
<strong>fromIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>toEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Endpoint Group</p>
</li>
<li>
<strong>toIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>toNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Network</p>
</li>
<li>
<strong>port</strong>: <em>required (integer)</em><p>Port No</p>
</li>
<li>
<strong>fromNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Network</p>
</li>
<li>
<strong>ruleId</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Rule Id</p>
</li>
<li>
<strong>priority</strong>: <em>required (integer)</em><p>Priority</p>
</li>
<li>
<strong>action</strong>: <em>required (string - pattern: ^(allow|deny)$)</em><p>Action</p>
</li>
<li>
<strong>direction</strong>: <em>required (string - pattern: ^(in|out)$)</em><p>Direction</p>
</li>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
</ul>
</li></ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "rule not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_rules__tenantname___policyname___ruleid__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_servicelbs__tenantname___servicename_"><span class="parent">/inspect/serviceLBs</span>/{tenantName}:{serviceName}/</a> <span class="methods"><a href="#inspect_servicelbs__tenantname___servicename__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_servicelbs__tenantname___servicename_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing serviceLB</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_servicelbs__tenantname___servicename__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a serviceLB.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_servicelbs__tenantname___servicename__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/serviceLBs</span>/{tenantName}:{serviceName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a serviceLB.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_servicelbs__tenantname___servicename__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_servicelbs__tenantname___servicename__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_servicelbs__tenantname___servicename__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_servicelbs__tenantname___servicename__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>serviceName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="inspect_servicelbs__tenantname___servicename__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Service network name</p>
</li>
<li>
<strong>serviceName</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>service name</p>
</li>
<li>
<strong>ipAddress</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Service ip</p>
</li>
<li>
<strong>selectors</strong>: <em>required (array of items)</em><p>labels key value pair</p>
</li>
<li>
<strong>ports</strong>: <em>required (array of items)</em><p>service provider port</p>
</li>
</ul>
</li>
<li>
<strong>Oper</strong>: <em>required (object)</em><ul>
<li>
<strong>serviceVip</strong>: <em>required (string)</em><p>allocated IP addresses</p>
</li>
<li>
<strong>numProviders</strong>: <em>required (integer)</em><p>number of provider endpoints for the service</p>
</li>
<li>
<strong>providers</strong>: <em>required (array of endpoint)</em><p>provider endpoints for the service</p>
<p><strong>Items</strong>: endpoint</p>
<div class="items"><ul></ul></div>
</li>
</ul>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "serviceLB not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_servicelbs__tenantname___servicename__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_inspect_tenants__tenantname_"><span class="parent">/inspect/tenants</span>/{tenantName}/</a> <span class="methods"><a href="#inspect_tenants__tenantname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_inspect_tenants__tenantname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing tenant</p></div>
<div class="list-group"><div onclick="window.location.href = '#inspect_tenants__tenantname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a tenant.</p></div>
<div class="clearfix"></div>
</div></div>
</div></div>
<div class="modal fade" tabindex="0" id="inspect_tenants__tenantname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/inspect/tenants</span>/{tenantName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a tenant.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#inspect_tenants__tenantname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#inspect_tenants__tenantname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#inspect_tenants__tenantname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="inspect_tenants__tenantname__get_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>tenantName</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="inspect_tenants__tenantname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>Config</strong>: <em>required (object)</em><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>defaultNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>Network name</p>
</li>
</ul>
</li>
<li>
<strong>Oper</strong>: <em>required (object)</em><ul>
<li>
<strong>totalNetworks</strong>: <em>required (integer)</em><p>total number of networks</p>
</li>
<li>
<strong>totalEPGs</strong>: <em>required (integer)</em><p>total number of EPGs</p>
</li>
<li>
<strong>totalNetprofiles</strong>: <em>required (integer)</em><p>total number of Netprofiles</p>
</li>
<li>
<strong>totalAppProfiles</strong>: <em>required (integer)</em><p>total number of App-Profiles</p>
</li>
<li>
<strong>totalServicelbs</strong>: <em>required (integer)</em><p>total number of Servicelbs</p>
</li>
<li>
<strong>totalPolicies</strong>: <em>required (integer)</em><p>total number of totalPolicies</p>
</li>
<li>
<strong>totalEndpoints</strong>: <em>required (integer)</em><p>total number of endpoints in the tenant</p>
</li>
<li>
<strong>endpoints</strong>: <em>required (array of endpoint)</em><p>endpoints in the tenant</p>
<p><strong>Items</strong>: endpoint</p>
<div class="items"><ul></ul></div>
</li>
<li>
<strong>networks</strong>: <em>required (array of network)</em><p>networks in the tenant</p>
<p><strong>Items</strong>: network</p>
<div class="items"><ul>
<li>
<strong>pktTag</strong>: <em>required (integer)</em><p>Vlan/Vxlan Tag</p>
</li>
<li>
<strong>encap</strong>: <em>required (string - pattern: ^(vlan|vxlan)$)</em><p>Encapsulation</p>
</li>
<li>
<strong>ipv6Gateway</strong>: <em>required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)</em><p>IPv6Gateway</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>ipv6Subnet</strong>: <em>required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)</em><p>IPv6Subnet</p>
</li>
<li>
<strong>gateway</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Gateway</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Network name</p>
</li>
<li>
<strong>subnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Subnet</p>
</li>
<li>
<strong>nwType</strong>: <em>required (string - pattern: ^(infra|data)$)</em><p>Network Type</p>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em><p>Configured Network Tag</p>
</li>
</ul></div>
</li>
<li>
<strong>endpointGroups</strong>: <em>required (array of endpointGroup)</em><p>endpointGroups in the tenant</p>
<p><strong>Items</strong>: endpointGroup</p>
<div class="items"><ul>
<li>
<strong>groupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>ipPool</strong>: <em>required (string - pattern: ^$|^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?$)</em><p>IP-pool</p>
</li>
<li>
<strong>policies</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>extContractsGrps</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>netProfile</strong>: <em>required (string)</em>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em>
</li>
</ul></div>
</li>
<li>
<strong>policies</strong>: <em>required (array of policy)</em><p>policies in the tenant</p>
<p><strong>Items</strong>: policy</p>
<div class="items"><ul>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
</ul></div>
</li>
<li>
<strong>servicelbs</strong>: <em>required (array of serviceLB)</em><p>servicelbs in the tenant</p>
<p><strong>Items</strong>: serviceLB</p>
<div class="items"><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Service network name</p>
</li>
<li>
<strong>serviceName</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>service name</p>
</li>
<li>
<strong>ipAddress</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Service ip</p>
</li>
<li>
<strong>selectors</strong>: <em>required (array of items)</em><p>labels key value pair</p>
</li>
<li>
<strong>ports</strong>: <em>required (array of items)</em><p>service provider port</p>
</li>
</ul></div>
</li>
</ul>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "tenant not found" }
</code></pre>
</div>
<div class="tab-pane" id="inspect_tenants__tenantname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="acigws" class="panel-title">ACI Gateways</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>ACI gateway settings</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_acigws"><span class="parent"></span>/aciGws/</a> <span class="methods"><a href="#acigws_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_acigws" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#acigws_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of aciGws.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="acigws_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/aciGws/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of aciGws.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#acigws_get_response" data-toggle="tab">Response</a></li>
<li><a href="#acigws_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="acigws_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of aciGw</p>
<p><strong>Items</strong>: aciGw</p>
<div class="items"><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(aciGw)$)</em><p>name of this block(must be 'aciGw')</p>
</li>
<li>
<strong>pathBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])*$)</em><p>List of ACI fabric ports connected to cluster</p>
</li>
<li>
<strong>nodeBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})*$)</em><p>List of ACI complete nodes to be bound</p>
</li>
<li>
<strong>physicalDomain</strong>: <em>required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Name of the physical domain</p>
</li>
<li>
<strong>enforcePolicies</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Enforce security policy</p>
</li>
<li>
<strong>includeCommonTenant</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Include common tenant when searching for objects</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="acigws_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_acigws_acigw"><span class="parent">/aciGws</span>/aciGw/</a> <span class="methods"><a href="#acigws_acigw_put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#acigws_acigw_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#acigws_acigw_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#acigws_acigw_delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_acigws_acigw" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing aciGw</p></div>
<div class="list-group">
<div onclick="window.location.href = '#acigws_acigw_put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a aciGw</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#acigws_acigw_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a aciGw.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#acigws_acigw_post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new aciGw.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#acigws_acigw_delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a aciGw.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="acigws_acigw_put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/aciGws</span>/aciGw/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a aciGw</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#acigws_acigw_put_request" data-toggle="tab">Request</a></li>
<li><a href="#acigws_acigw_put_response" data-toggle="tab">Response</a></li>
<li><a href="#acigws_acigw_put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="acigws_acigw_put_request">
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(aciGw)$)</em><p>name of this block(must be 'aciGw')</p>
</li>
<li>
<strong>pathBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])*$)</em><p>List of ACI fabric ports connected to cluster</p>
</li>
<li>
<strong>nodeBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})*$)</em><p>List of ACI complete nodes to be bound</p>
</li>
<li>
<strong>physicalDomain</strong>: <em>required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Name of the physical domain</p>
</li>
<li>
<strong>enforcePolicies</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Enforce security policy</p>
</li>
<li>
<strong>includeCommonTenant</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Include common tenant when searching for objects</p>
</li>
</ul>
</div>
<div class="tab-pane" id="acigws_acigw_put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(aciGw)$)</em><p>name of this block(must be 'aciGw')</p>
</li>
<li>
<strong>pathBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])*$)</em><p>List of ACI fabric ports connected to cluster</p>
</li>
<li>
<strong>nodeBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})*$)</em><p>List of ACI complete nodes to be bound</p>
</li>
<li>
<strong>physicalDomain</strong>: <em>required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Name of the physical domain</p>
</li>
<li>
<strong>enforcePolicies</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Enforce security policy</p>
</li>
<li>
<strong>includeCommonTenant</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Include common tenant when searching for objects</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "aciGw not found" }
</code></pre>
</div>
<div class="tab-pane" id="acigws_acigw_put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="acigws_acigw_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/aciGws</span>/aciGw/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a aciGw.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#acigws_acigw_get_response" data-toggle="tab">Response</a></li>
<li><a href="#acigws_acigw_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="acigws_acigw_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(aciGw)$)</em><p>name of this block(must be 'aciGw')</p>
</li>
<li>
<strong>pathBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])*$)</em><p>List of ACI fabric ports connected to cluster</p>
</li>
<li>
<strong>nodeBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})*$)</em><p>List of ACI complete nodes to be bound</p>
</li>
<li>
<strong>physicalDomain</strong>: <em>required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Name of the physical domain</p>
</li>
<li>
<strong>enforcePolicies</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Enforce security policy</p>
</li>
<li>
<strong>includeCommonTenant</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Include common tenant when searching for objects</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "aciGw not found" }
</code></pre>
</div>
<div class="tab-pane" id="acigws_acigw_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="acigws_acigw_post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/aciGws</span>/aciGw/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new aciGw.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#acigws_acigw_post_request" data-toggle="tab">Request</a></li>
<li><a href="#acigws_acigw_post_response" data-toggle="tab">Response</a></li>
<li><a href="#acigws_acigw_post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="acigws_acigw_post_request">
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(aciGw)$)</em><p>name of this block(must be 'aciGw')</p>
</li>
<li>
<strong>pathBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])*$)</em><p>List of ACI fabric ports connected to cluster</p>
</li>
<li>
<strong>nodeBindings</strong>: <em>required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})*$)</em><p>List of ACI complete nodes to be bound</p>
</li>
<li>
<strong>physicalDomain</strong>: <em>required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Name of the physical domain</p>
</li>
<li>
<strong>enforcePolicies</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Enforce security policy</p>
</li>
<li>
<strong>includeCommonTenant</strong>: <em>required (string - maxLength: 64 - pattern: ^(yes|no){1}$)</em><p>Include common tenant when searching for objects</p>
</li>
</ul>
</div>
<div class="tab-pane" id="acigws_acigw_post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="acigws_acigw_post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="acigws_acigw_delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/aciGws</span>/aciGw/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a aciGw.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#acigws_acigw_delete_response" data-toggle="tab">Response</a></li>
<li><a href="#acigws_acigw_delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="acigws_acigw_delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="acigws_acigw_delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="appprofiles" class="panel-title">Application Profiles</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>A collection of appProfiles</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_appprofiles"><span class="parent"></span>/appProfiles/</a> <span class="methods"><a href="#appprofiles_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_appprofiles" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#appprofiles_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of appProfiles.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="appprofiles_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/appProfiles/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of appProfiles.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#appprofiles_get_response" data-toggle="tab">Response</a></li>
<li><a href="#appprofiles_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="appprofiles_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of appProfile</p>
<p><strong>Items</strong>: appProfile</p>
<div class="items"><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>appProfileName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Application Profile Name</p>
</li>
<li>
<strong>endpointGroups</strong>: <em>required (array of items)</em><p>Member groups of the appProf</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="appprofiles_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_appprofiles__tenantname___appprofilename_"><span class="parent">/appProfiles</span>/{tenantName}:{appProfileName}/</a> <span class="methods"><a href="#appprofiles__tenantname___appprofilename__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#appprofiles__tenantname___appprofilename__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#appprofiles__tenantname___appprofilename__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#appprofiles__tenantname___appprofilename__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_appprofiles__tenantname___appprofilename_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing appProfile</p></div>
<div class="list-group">
<div onclick="window.location.href = '#appprofiles__tenantname___appprofilename__put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a appProfile</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#appprofiles__tenantname___appprofilename__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a appProfile.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#appprofiles__tenantname___appprofilename__post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new appProfile.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#appprofiles__tenantname___appprofilename__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a appProfile.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="appprofiles__tenantname___appprofilename__put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/appProfiles</span>/{tenantName}:{appProfileName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a appProfile</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#appprofiles__tenantname___appprofilename__put_request" data-toggle="tab">Request</a></li>
<li><a href="#appprofiles__tenantname___appprofilename__put_response" data-toggle="tab">Response</a></li>
<li><a href="#appprofiles__tenantname___appprofilename__put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="appprofiles__tenantname___appprofilename__put_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>appProfileName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: netmaster.appProfile</p>
</div>
<div class="tab-pane" id="appprofiles__tenantname___appprofilename__put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>appProfileName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Application Profile Name</p>
</li>
<li>
<strong>endpointGroups</strong>: <em>required (array of items)</em><p>Member groups of the appProf</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "appProfile not found" }
</code></pre>
</div>
<div class="tab-pane" id="appprofiles__tenantname___appprofilename__put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="appprofiles__tenantname___appprofilename__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/appProfiles</span>/{tenantName}:{appProfileName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a appProfile.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#appprofiles__tenantname___appprofilename__get_request" data-toggle="tab">Request</a></li>
<li><a href="#appprofiles__tenantname___appprofilename__get_response" data-toggle="tab">Response</a></li>
<li><a href="#appprofiles__tenantname___appprofilename__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="appprofiles__tenantname___appprofilename__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>appProfileName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="appprofiles__tenantname___appprofilename__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>appProfileName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Application Profile Name</p>
</li>
<li>
<strong>endpointGroups</strong>: <em>required (array of items)</em><p>Member groups of the appProf</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "appProfile not found" }
</code></pre>
</div>
<div class="tab-pane" id="appprofiles__tenantname___appprofilename__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="appprofiles__tenantname___appprofilename__post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/appProfiles</span>/{tenantName}:{appProfileName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new appProfile.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#appprofiles__tenantname___appprofilename__post_request" data-toggle="tab">Request</a></li>
<li><a href="#appprofiles__tenantname___appprofilename__post_response" data-toggle="tab">Response</a></li>
<li><a href="#appprofiles__tenantname___appprofilename__post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="appprofiles__tenantname___appprofilename__post_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>appProfileName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>appProfileName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Application Profile Name</p>
</li>
<li>
<strong>endpointGroups</strong>: <em>required (array of items)</em><p>Member groups of the appProf</p>
</li>
</ul>
</div>
<div class="tab-pane" id="appprofiles__tenantname___appprofilename__post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="appprofiles__tenantname___appprofilename__post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="appprofiles__tenantname___appprofilename__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/appProfiles</span>/{tenantName}:{appProfileName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a appProfile.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#appprofiles__tenantname___appprofilename__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#appprofiles__tenantname___appprofilename__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#appprofiles__tenantname___appprofilename__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="appprofiles__tenantname___appprofilename__delete_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>appProfileName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="appprofiles__tenantname___appprofilename__delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="appprofiles__tenantname___appprofilename__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="bgps" class="panel-title">BGP</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>BGP settings</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_bgps"><span class="parent"></span>/Bgps/</a> <span class="methods"><a href="#bgps_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_bgps" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#bgps_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of Bgps.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="bgps_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/Bgps/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of Bgps.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#bgps_get_response" data-toggle="tab">Response</a></li>
<li><a href="#bgps_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="bgps_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of Bgp</p>
<p><strong>Items</strong>: Bgp</p>
<div class="items"><ul>
<li>
<strong>hostname</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>host name</p>
</li>
<li>
<strong>routerip</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Bgp router intf ip</p>
</li>
<li>
<strong>as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor-as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Bgp neighbor</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="bgps_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_bgps__hostname_"><span class="parent">/Bgps</span>/{hostname}/</a> <span class="methods"><a href="#bgps__hostname__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#bgps__hostname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#bgps__hostname__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#bgps__hostname__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_bgps__hostname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing Bgp</p></div>
<div class="list-group">
<div onclick="window.location.href = '#bgps__hostname__put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a Bgp</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#bgps__hostname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a Bgp.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#bgps__hostname__post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new Bgp.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#bgps__hostname__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a Bgp.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="bgps__hostname__put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/Bgps</span>/{hostname}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a Bgp</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#bgps__hostname__put_request" data-toggle="tab">Request</a></li>
<li><a href="#bgps__hostname__put_response" data-toggle="tab">Response</a></li>
<li><a href="#bgps__hostname__put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="bgps__hostname__put_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>hostname</strong>: <em>required (string)</em>
</li></ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>hostname</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>host name</p>
</li>
<li>
<strong>routerip</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Bgp router intf ip</p>
</li>
<li>
<strong>as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor-as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Bgp neighbor</p>
</li>
</ul>
</div>
<div class="tab-pane" id="bgps__hostname__put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>hostname</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>host name</p>
</li>
<li>
<strong>routerip</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Bgp router intf ip</p>
</li>
<li>
<strong>as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor-as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Bgp neighbor</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "Bgp not found" }
</code></pre>
</div>
<div class="tab-pane" id="bgps__hostname__put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="bgps__hostname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/Bgps</span>/{hostname}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a Bgp.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#bgps__hostname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#bgps__hostname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#bgps__hostname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="bgps__hostname__get_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>hostname</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="bgps__hostname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>hostname</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>host name</p>
</li>
<li>
<strong>routerip</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Bgp router intf ip</p>
</li>
<li>
<strong>as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor-as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Bgp neighbor</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "Bgp not found" }
</code></pre>
</div>
<div class="tab-pane" id="bgps__hostname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="bgps__hostname__post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/Bgps</span>/{hostname}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new Bgp.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#bgps__hostname__post_request" data-toggle="tab">Request</a></li>
<li><a href="#bgps__hostname__post_response" data-toggle="tab">Response</a></li>
<li><a href="#bgps__hostname__post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="bgps__hostname__post_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>hostname</strong>: <em>required (string)</em>
</li></ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>hostname</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>host name</p>
</li>
<li>
<strong>routerip</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Bgp router intf ip</p>
</li>
<li>
<strong>as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor-as</strong>: <em>required (string - maxLength: 64)</em><p>AS id</p>
</li>
<li>
<strong>neighbor</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Bgp neighbor</p>
</li>
</ul>
</div>
<div class="tab-pane" id="bgps__hostname__post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="bgps__hostname__post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="bgps__hostname__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/Bgps</span>/{hostname}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a Bgp.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#bgps__hostname__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#bgps__hostname__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#bgps__hostname__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="bgps__hostname__delete_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>hostname</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="bgps__hostname__delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="bgps__hostname__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="endpointgroups" class="panel-title">Endpoint Groups</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>A collection of endpointGroups</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_endpointgroups"><span class="parent"></span>/endpointGroups/</a> <span class="methods"><a href="#endpointgroups_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_endpointgroups" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#endpointgroups_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of endpointGroups.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="endpointgroups_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/endpointGroups/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of endpointGroups.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#endpointgroups_get_response" data-toggle="tab">Response</a></li>
<li><a href="#endpointgroups_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="endpointgroups_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of endpointGroup</p>
<p><strong>Items</strong>: endpointGroup</p>
<div class="items"><ul>
<li>
<strong>groupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>ipPool</strong>: <em>required (string - pattern: ^$|^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?$)</em><p>IP-pool</p>
</li>
<li>
<strong>policies</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>extContractsGrps</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>netProfile</strong>: <em>required (string)</em>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em>
</li>
</ul></div>
</div>
<div class="tab-pane" id="endpointgroups_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_endpointgroups__tenantname___groupname_"><span class="parent">/endpointGroups</span>/{tenantName}:{groupName}/</a> <span class="methods"><a href="#endpointgroups__tenantname___groupname__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#endpointgroups__tenantname___groupname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#endpointgroups__tenantname___groupname__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#endpointgroups__tenantname___groupname__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_endpointgroups__tenantname___groupname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing endpointGroup</p></div>
<div class="list-group">
<div onclick="window.location.href = '#endpointgroups__tenantname___groupname__put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a endpointGroup</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#endpointgroups__tenantname___groupname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a endpointGroup.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#endpointgroups__tenantname___groupname__post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new endpointGroup.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#endpointgroups__tenantname___groupname__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a endpointGroup.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="endpointgroups__tenantname___groupname__put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/endpointGroups</span>/{tenantName}:{groupName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a endpointGroup</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#endpointgroups__tenantname___groupname__put_request" data-toggle="tab">Request</a></li>
<li><a href="#endpointgroups__tenantname___groupname__put_response" data-toggle="tab">Response</a></li>
<li><a href="#endpointgroups__tenantname___groupname__put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="endpointgroups__tenantname___groupname__put_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>groupName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: netmaster.endpointGroup</p>
</div>
<div class="tab-pane" id="endpointgroups__tenantname___groupname__put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>groupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>ipPool</strong>: <em>required (string - pattern: ^$|^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?$)</em><p>IP-pool</p>
</li>
<li>
<strong>policies</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>extContractsGrps</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>netProfile</strong>: <em>required (string)</em>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "endpointGroup not found" }
</code></pre>
</div>
<div class="tab-pane" id="endpointgroups__tenantname___groupname__put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="endpointgroups__tenantname___groupname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/endpointGroups</span>/{tenantName}:{groupName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a endpointGroup.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#endpointgroups__tenantname___groupname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#endpointgroups__tenantname___groupname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#endpointgroups__tenantname___groupname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="endpointgroups__tenantname___groupname__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>groupName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="endpointgroups__tenantname___groupname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>groupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>ipPool</strong>: <em>required (string - pattern: ^$|^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?$)</em><p>IP-pool</p>
</li>
<li>
<strong>policies</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>extContractsGrps</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>netProfile</strong>: <em>required (string)</em>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "endpointGroup not found" }
</code></pre>
</div>
<div class="tab-pane" id="endpointgroups__tenantname___groupname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="endpointgroups__tenantname___groupname__post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/endpointGroups</span>/{tenantName}:{groupName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new endpointGroup.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#endpointgroups__tenantname___groupname__post_request" data-toggle="tab">Request</a></li>
<li><a href="#endpointgroups__tenantname___groupname__post_response" data-toggle="tab">Response</a></li>
<li><a href="#endpointgroups__tenantname___groupname__post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="endpointgroups__tenantname___groupname__post_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>groupName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>groupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em>
</li>
<li>
<strong>ipPool</strong>: <em>required (string - pattern: ^$|^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?$)</em><p>IP-pool</p>
</li>
<li>
<strong>policies</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>extContractsGrps</strong>: <em>required (array of items)</em>
</li>
<li>
<strong>netProfile</strong>: <em>required (string)</em>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="endpointgroups__tenantname___groupname__post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="endpointgroups__tenantname___groupname__post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="endpointgroups__tenantname___groupname__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/endpointGroups</span>/{tenantName}:{groupName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a endpointGroup.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#endpointgroups__tenantname___groupname__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#endpointgroups__tenantname___groupname__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#endpointgroups__tenantname___groupname__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="endpointgroups__tenantname___groupname__delete_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>groupName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="endpointgroups__tenantname___groupname__delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="endpointgroups__tenantname___groupname__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="extcontractsgroups" class="panel-title">External Contract Groups</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>A collection of extContractsGroups</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_extcontractsgroups"><span class="parent"></span>/extContractsGroups/</a> <span class="methods"><a href="#extcontractsgroups_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_extcontractsgroups" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#extcontractsgroups_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of extContractsGroups.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="extcontractsgroups_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/extContractsGroups/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of extContractsGroups.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#extcontractsgroups_get_response" data-toggle="tab">Response</a></li>
<li><a href="#extcontractsgroups_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="extcontractsgroups_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of extContractsGroup</p>
<p><strong>Items</strong>: extContractsGroup</p>
<div class="items"><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant name</p>
</li>
<li>
<strong>contractsGroupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Contracts group name</p>
</li>
<li>
<strong>contractsType</strong>: <em>required (string)</em><p>Contracts type</p>
</li>
<li>
<strong>contracts</strong>: <em>required (array of items)</em><p>Contracts list</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="extcontractsgroups_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_extcontractsgroups__tenantname___contractsgroupname_"><span class="parent">/extContractsGroups</span>/{tenantName}:{contractsGroupName}/</a> <span class="methods"><a href="#extcontractsgroups__tenantname___contractsgroupname__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#extcontractsgroups__tenantname___contractsgroupname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#extcontractsgroups__tenantname___contractsgroupname__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#extcontractsgroups__tenantname___contractsgroupname__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_extcontractsgroups__tenantname___contractsgroupname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing extContractsGroup</p></div>
<div class="list-group">
<div onclick="window.location.href = '#extcontractsgroups__tenantname___contractsgroupname__put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a extContractsGroup</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#extcontractsgroups__tenantname___contractsgroupname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a extContractsGroup.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#extcontractsgroups__tenantname___contractsgroupname__post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new extContractsGroup.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#extcontractsgroups__tenantname___contractsgroupname__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a extContractsGroup.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="extcontractsgroups__tenantname___contractsgroupname__put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/extContractsGroups</span>/{tenantName}:{contractsGroupName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a extContractsGroup</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#extcontractsgroups__tenantname___contractsgroupname__put_request" data-toggle="tab">Request</a></li>
<li><a href="#extcontractsgroups__tenantname___contractsgroupname__put_response" data-toggle="tab">Response</a></li>
<li><a href="#extcontractsgroups__tenantname___contractsgroupname__put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="extcontractsgroups__tenantname___contractsgroupname__put_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>contractsGroupName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: netmaster.extContractsGroup</p>
</div>
<div class="tab-pane" id="extcontractsgroups__tenantname___contractsgroupname__put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant name</p>
</li>
<li>
<strong>contractsGroupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Contracts group name</p>
</li>
<li>
<strong>contractsType</strong>: <em>required (string)</em><p>Contracts type</p>
</li>
<li>
<strong>contracts</strong>: <em>required (array of items)</em><p>Contracts list</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "extContractsGroup not found" }
</code></pre>
</div>
<div class="tab-pane" id="extcontractsgroups__tenantname___contractsgroupname__put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="extcontractsgroups__tenantname___contractsgroupname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/extContractsGroups</span>/{tenantName}:{contractsGroupName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a extContractsGroup.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#extcontractsgroups__tenantname___contractsgroupname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#extcontractsgroups__tenantname___contractsgroupname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#extcontractsgroups__tenantname___contractsgroupname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="extcontractsgroups__tenantname___contractsgroupname__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>contractsGroupName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="extcontractsgroups__tenantname___contractsgroupname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant name</p>
</li>
<li>
<strong>contractsGroupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Contracts group name</p>
</li>
<li>
<strong>contractsType</strong>: <em>required (string)</em><p>Contracts type</p>
</li>
<li>
<strong>contracts</strong>: <em>required (array of items)</em><p>Contracts list</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "extContractsGroup not found" }
</code></pre>
</div>
<div class="tab-pane" id="extcontractsgroups__tenantname___contractsgroupname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="extcontractsgroups__tenantname___contractsgroupname__post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/extContractsGroups</span>/{tenantName}:{contractsGroupName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new extContractsGroup.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#extcontractsgroups__tenantname___contractsgroupname__post_request" data-toggle="tab">Request</a></li>
<li><a href="#extcontractsgroups__tenantname___contractsgroupname__post_response" data-toggle="tab">Response</a></li>
<li><a href="#extcontractsgroups__tenantname___contractsgroupname__post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="extcontractsgroups__tenantname___contractsgroupname__post_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>contractsGroupName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant name</p>
</li>
<li>
<strong>contractsGroupName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Contracts group name</p>
</li>
<li>
<strong>contractsType</strong>: <em>required (string)</em><p>Contracts type</p>
</li>
<li>
<strong>contracts</strong>: <em>required (array of items)</em><p>Contracts list</p>
</li>
</ul>
</div>
<div class="tab-pane" id="extcontractsgroups__tenantname___contractsgroupname__post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="extcontractsgroups__tenantname___contractsgroupname__post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="extcontractsgroups__tenantname___contractsgroupname__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/extContractsGroups</span>/{tenantName}:{contractsGroupName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a extContractsGroup.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#extcontractsgroups__tenantname___contractsgroupname__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#extcontractsgroups__tenantname___contractsgroupname__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#extcontractsgroups__tenantname___contractsgroupname__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="extcontractsgroups__tenantname___contractsgroupname__delete_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>contractsGroupName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="extcontractsgroups__tenantname___contractsgroupname__delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="extcontractsgroups__tenantname___contractsgroupname__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="globals" class="panel-title">Globals</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>Contiv global settings</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_globals"><span class="parent"></span>/globals/</a> <span class="methods"><a href="#globals_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_globals" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#globals_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of globals.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="globals_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/globals/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of globals.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#globals_get_response" data-toggle="tab">Response</a></li>
<li><a href="#globals_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="globals_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of global</p>
<p><strong>Items</strong>: global</p>
<div class="items"><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(global)$)</em><p>name of this block(must be 'global')</p>
</li>
<li>
<strong>networkInfraType</strong>: <em>required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)</em><p>Network infrastructure type</p>
</li>
<li>
<strong>vlans</strong>: <em>required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)</em><p>Allowed vlan range</p>
</li>
<li>
<strong>vxlans</strong>: <em>required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)</em><p>Allwed vxlan range</p>
</li>
<li>
<strong>fwdMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)</em><p>Forwarding Mode</p>
</li>
<li>
<strong>arpMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)</em><p>ARP Mode</p>
</li>
<li>
<strong>pvtSubnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)</em><p>Private Subnet used by host bridge</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="globals_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_globals_global"><span class="parent">/globals</span>/global/</a> <span class="methods"><a href="#globals_global_put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#globals_global_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#globals_global_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#globals_global_delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_globals_global" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing global</p></div>
<div class="list-group">
<div onclick="window.location.href = '#globals_global_put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a global</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#globals_global_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a global.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#globals_global_post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new global.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#globals_global_delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a global.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="globals_global_put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/globals</span>/global/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a global</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#globals_global_put_request" data-toggle="tab">Request</a></li>
<li><a href="#globals_global_put_response" data-toggle="tab">Response</a></li>
<li><a href="#globals_global_put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="globals_global_put_request">
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(global)$)</em><p>name of this block(must be 'global')</p>
</li>
<li>
<strong>networkInfraType</strong>: <em>required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)</em><p>Network infrastructure type</p>
</li>
<li>
<strong>vlans</strong>: <em>required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)</em><p>Allowed vlan range</p>
</li>
<li>
<strong>vxlans</strong>: <em>required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)</em><p>Allwed vxlan range</p>
</li>
<li>
<strong>fwdMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)</em><p>Forwarding Mode</p>
</li>
<li>
<strong>arpMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)</em><p>ARP Mode</p>
</li>
<li>
<strong>pvtSubnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)</em><p>Private Subnet used by host bridge</p>
</li>
</ul>
</div>
<div class="tab-pane" id="globals_global_put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(global)$)</em><p>name of this block(must be 'global')</p>
</li>
<li>
<strong>networkInfraType</strong>: <em>required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)</em><p>Network infrastructure type</p>
</li>
<li>
<strong>vlans</strong>: <em>required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)</em><p>Allowed vlan range</p>
</li>
<li>
<strong>vxlans</strong>: <em>required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)</em><p>Allwed vxlan range</p>
</li>
<li>
<strong>fwdMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)</em><p>Forwarding Mode</p>
</li>
<li>
<strong>arpMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)</em><p>ARP Mode</p>
</li>
<li>
<strong>pvtSubnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)</em><p>Private Subnet used by host bridge</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "global not found" }
</code></pre>
</div>
<div class="tab-pane" id="globals_global_put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="globals_global_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/globals</span>/global/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a global.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#globals_global_get_response" data-toggle="tab">Response</a></li>
<li><a href="#globals_global_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="globals_global_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(global)$)</em><p>name of this block(must be 'global')</p>
</li>
<li>
<strong>networkInfraType</strong>: <em>required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)</em><p>Network infrastructure type</p>
</li>
<li>
<strong>vlans</strong>: <em>required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)</em><p>Allowed vlan range</p>
</li>
<li>
<strong>vxlans</strong>: <em>required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)</em><p>Allwed vxlan range</p>
</li>
<li>
<strong>fwdMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)</em><p>Forwarding Mode</p>
</li>
<li>
<strong>arpMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)</em><p>ARP Mode</p>
</li>
<li>
<strong>pvtSubnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)</em><p>Private Subnet used by host bridge</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "global not found" }
</code></pre>
</div>
<div class="tab-pane" id="globals_global_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="globals_global_post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/globals</span>/global/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new global.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#globals_global_post_request" data-toggle="tab">Request</a></li>
<li><a href="#globals_global_post_response" data-toggle="tab">Response</a></li>
<li><a href="#globals_global_post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="globals_global_post_request">
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>name</strong>: <em>required (string - maxLength: 64 - pattern: ^(global)$)</em><p>name of this block(must be 'global')</p>
</li>
<li>
<strong>networkInfraType</strong>: <em>required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)</em><p>Network infrastructure type</p>
</li>
<li>
<strong>vlans</strong>: <em>required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)</em><p>Allowed vlan range</p>
</li>
<li>
<strong>vxlans</strong>: <em>required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)</em><p>Allwed vxlan range</p>
</li>
<li>
<strong>fwdMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)</em><p>Forwarding Mode</p>
</li>
<li>
<strong>arpMode</strong>: <em>required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)</em><p>ARP Mode</p>
</li>
<li>
<strong>pvtSubnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)</em><p>Private Subnet used by host bridge</p>
</li>
</ul>
</div>
<div class="tab-pane" id="globals_global_post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="globals_global_post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="globals_global_delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/globals</span>/global/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a global.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#globals_global_delete_response" data-toggle="tab">Response</a></li>
<li><a href="#globals_global_delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="globals_global_delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="globals_global_delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="netprofiles" class="panel-title">Network Profiles</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>A collection of netprofiles</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_netprofiles"><span class="parent"></span>/netprofiles/</a> <span class="methods"><a href="#netprofiles_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_netprofiles" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#netprofiles_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of netprofiles.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="netprofiles_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/netprofiles/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of netprofiles.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#netprofiles_get_response" data-toggle="tab">Response</a></li>
<li><a href="#netprofiles_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="netprofiles_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of netprofile</p>
<p><strong>Items</strong>: netprofile</p>
<div class="items"><ul>
<li>
<strong>profileName</strong>: <em>required (string - maxLength: 64)</em><p>Network profile name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string)</em><p>Tenant name</p>
</li>
<li>
<strong>bandwidth</strong>: <em>required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)</em><p>Allocated bandwidth</p>
</li>
<li>
<strong>DSCP</strong>: <em>required (integer)</em><p>DSCP</p>
</li>
<li>
<strong>burst</strong>: <em>required (integer)</em><p>burst size</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="netprofiles_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_netprofiles__tenantname___profilename_"><span class="parent">/netprofiles</span>/{tenantName}:{profileName}/</a> <span class="methods"><a href="#netprofiles__tenantname___profilename__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#netprofiles__tenantname___profilename__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#netprofiles__tenantname___profilename__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#netprofiles__tenantname___profilename__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_netprofiles__tenantname___profilename_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing netprofile</p></div>
<div class="list-group">
<div onclick="window.location.href = '#netprofiles__tenantname___profilename__put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a netprofile</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#netprofiles__tenantname___profilename__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a netprofile.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#netprofiles__tenantname___profilename__post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new netprofile.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#netprofiles__tenantname___profilename__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a netprofile.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="netprofiles__tenantname___profilename__put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/netprofiles</span>/{tenantName}:{profileName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a netprofile</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#netprofiles__tenantname___profilename__put_request" data-toggle="tab">Request</a></li>
<li><a href="#netprofiles__tenantname___profilename__put_response" data-toggle="tab">Response</a></li>
<li><a href="#netprofiles__tenantname___profilename__put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="netprofiles__tenantname___profilename__put_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>profileName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>profileName</strong>: <em>required (string - maxLength: 64)</em><p>Network profile name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string)</em><p>Tenant name</p>
</li>
<li>
<strong>bandwidth</strong>: <em>required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)</em><p>Allocated bandwidth</p>
</li>
<li>
<strong>DSCP</strong>: <em>required (integer)</em><p>DSCP</p>
</li>
<li>
<strong>burst</strong>: <em>required (integer)</em><p>burst size</p>
</li>
</ul>
</div>
<div class="tab-pane" id="netprofiles__tenantname___profilename__put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>profileName</strong>: <em>required (string - maxLength: 64)</em><p>Network profile name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string)</em><p>Tenant name</p>
</li>
<li>
<strong>bandwidth</strong>: <em>required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)</em><p>Allocated bandwidth</p>
</li>
<li>
<strong>DSCP</strong>: <em>required (integer)</em><p>DSCP</p>
</li>
<li>
<strong>burst</strong>: <em>required (integer)</em><p>burst size</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "netprofile not found" }
</code></pre>
</div>
<div class="tab-pane" id="netprofiles__tenantname___profilename__put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="netprofiles__tenantname___profilename__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/netprofiles</span>/{tenantName}:{profileName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a netprofile.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#netprofiles__tenantname___profilename__get_request" data-toggle="tab">Request</a></li>
<li><a href="#netprofiles__tenantname___profilename__get_response" data-toggle="tab">Response</a></li>
<li><a href="#netprofiles__tenantname___profilename__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="netprofiles__tenantname___profilename__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>profileName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="netprofiles__tenantname___profilename__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>profileName</strong>: <em>required (string - maxLength: 64)</em><p>Network profile name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string)</em><p>Tenant name</p>
</li>
<li>
<strong>bandwidth</strong>: <em>required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)</em><p>Allocated bandwidth</p>
</li>
<li>
<strong>DSCP</strong>: <em>required (integer)</em><p>DSCP</p>
</li>
<li>
<strong>burst</strong>: <em>required (integer)</em><p>burst size</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "netprofile not found" }
</code></pre>
</div>
<div class="tab-pane" id="netprofiles__tenantname___profilename__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="netprofiles__tenantname___profilename__post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/netprofiles</span>/{tenantName}:{profileName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new netprofile.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#netprofiles__tenantname___profilename__post_request" data-toggle="tab">Request</a></li>
<li><a href="#netprofiles__tenantname___profilename__post_response" data-toggle="tab">Response</a></li>
<li><a href="#netprofiles__tenantname___profilename__post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="netprofiles__tenantname___profilename__post_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>profileName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>profileName</strong>: <em>required (string - maxLength: 64)</em><p>Network profile name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string)</em><p>Tenant name</p>
</li>
<li>
<strong>bandwidth</strong>: <em>required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)</em><p>Allocated bandwidth</p>
</li>
<li>
<strong>DSCP</strong>: <em>required (integer)</em><p>DSCP</p>
</li>
<li>
<strong>burst</strong>: <em>required (integer)</em><p>burst size</p>
</li>
</ul>
</div>
<div class="tab-pane" id="netprofiles__tenantname___profilename__post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="netprofiles__tenantname___profilename__post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="netprofiles__tenantname___profilename__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/netprofiles</span>/{tenantName}:{profileName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a netprofile.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#netprofiles__tenantname___profilename__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#netprofiles__tenantname___profilename__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#netprofiles__tenantname___profilename__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="netprofiles__tenantname___profilename__delete_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>profileName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="netprofiles__tenantname___profilename__delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="netprofiles__tenantname___profilename__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="networks" class="panel-title">Networks</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>A collection of networks</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_networks"><span class="parent"></span>/networks/</a> <span class="methods"><a href="#networks_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_networks" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#networks_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of networks.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="networks_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/networks/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of networks.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#networks_get_response" data-toggle="tab">Response</a></li>
<li><a href="#networks_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="networks_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of network</p>
<p><strong>Items</strong>: network</p>
<div class="items"><ul>
<li>
<strong>pktTag</strong>: <em>required (integer)</em><p>Vlan/Vxlan Tag</p>
</li>
<li>
<strong>encap</strong>: <em>required (string - pattern: ^(vlan|vxlan)$)</em><p>Encapsulation</p>
</li>
<li>
<strong>ipv6Gateway</strong>: <em>required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)</em><p>IPv6Gateway</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>ipv6Subnet</strong>: <em>required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)</em><p>IPv6Subnet</p>
</li>
<li>
<strong>gateway</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Gateway</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Network name</p>
</li>
<li>
<strong>subnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Subnet</p>
</li>
<li>
<strong>nwType</strong>: <em>required (string - pattern: ^(infra|data)$)</em><p>Network Type</p>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em><p>Configured Network Tag</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="networks_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_networks__tenantname___networkname_"><span class="parent">/networks</span>/{tenantName}:{networkName}/</a> <span class="methods"><a href="#networks__tenantname___networkname__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#networks__tenantname___networkname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#networks__tenantname___networkname__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#networks__tenantname___networkname__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_networks__tenantname___networkname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing network</p></div>
<div class="list-group">
<div onclick="window.location.href = '#networks__tenantname___networkname__put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a network</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#networks__tenantname___networkname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a network.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#networks__tenantname___networkname__post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new network.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#networks__tenantname___networkname__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a network.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="networks__tenantname___networkname__put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/networks</span>/{tenantName}:{networkName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a network</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#networks__tenantname___networkname__put_request" data-toggle="tab">Request</a></li>
<li><a href="#networks__tenantname___networkname__put_response" data-toggle="tab">Response</a></li>
<li><a href="#networks__tenantname___networkname__put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="networks__tenantname___networkname__put_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>pktTag</strong>: <em>required (integer)</em><p>Vlan/Vxlan Tag</p>
</li>
<li>
<strong>encap</strong>: <em>required (string - pattern: ^(vlan|vxlan)$)</em><p>Encapsulation</p>
</li>
<li>
<strong>ipv6Gateway</strong>: <em>required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)</em><p>IPv6Gateway</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>ipv6Subnet</strong>: <em>required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)</em><p>IPv6Subnet</p>
</li>
<li>
<strong>gateway</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Gateway</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Network name</p>
</li>
<li>
<strong>subnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Subnet</p>
</li>
<li>
<strong>nwType</strong>: <em>required (string - pattern: ^(infra|data)$)</em><p>Network Type</p>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em><p>Configured Network Tag</p>
</li>
</ul>
</div>
<div class="tab-pane" id="networks__tenantname___networkname__put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>pktTag</strong>: <em>required (integer)</em><p>Vlan/Vxlan Tag</p>
</li>
<li>
<strong>encap</strong>: <em>required (string - pattern: ^(vlan|vxlan)$)</em><p>Encapsulation</p>
</li>
<li>
<strong>ipv6Gateway</strong>: <em>required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)</em><p>IPv6Gateway</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>ipv6Subnet</strong>: <em>required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)</em><p>IPv6Subnet</p>
</li>
<li>
<strong>gateway</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Gateway</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Network name</p>
</li>
<li>
<strong>subnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Subnet</p>
</li>
<li>
<strong>nwType</strong>: <em>required (string - pattern: ^(infra|data)$)</em><p>Network Type</p>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em><p>Configured Network Tag</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "network not found" }
</code></pre>
</div>
<div class="tab-pane" id="networks__tenantname___networkname__put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="networks__tenantname___networkname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/networks</span>/{tenantName}:{networkName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a network.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#networks__tenantname___networkname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#networks__tenantname___networkname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#networks__tenantname___networkname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="networks__tenantname___networkname__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="networks__tenantname___networkname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>pktTag</strong>: <em>required (integer)</em><p>Vlan/Vxlan Tag</p>
</li>
<li>
<strong>encap</strong>: <em>required (string - pattern: ^(vlan|vxlan)$)</em><p>Encapsulation</p>
</li>
<li>
<strong>ipv6Gateway</strong>: <em>required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)</em><p>IPv6Gateway</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>ipv6Subnet</strong>: <em>required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)</em><p>IPv6Subnet</p>
</li>
<li>
<strong>gateway</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Gateway</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Network name</p>
</li>
<li>
<strong>subnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Subnet</p>
</li>
<li>
<strong>nwType</strong>: <em>required (string - pattern: ^(infra|data)$)</em><p>Network Type</p>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em><p>Configured Network Tag</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "network not found" }
</code></pre>
</div>
<div class="tab-pane" id="networks__tenantname___networkname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="networks__tenantname___networkname__post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/networks</span>/{tenantName}:{networkName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new network.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#networks__tenantname___networkname__post_request" data-toggle="tab">Request</a></li>
<li><a href="#networks__tenantname___networkname__post_response" data-toggle="tab">Response</a></li>
<li><a href="#networks__tenantname___networkname__post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="networks__tenantname___networkname__post_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>pktTag</strong>: <em>required (integer)</em><p>Vlan/Vxlan Tag</p>
</li>
<li>
<strong>encap</strong>: <em>required (string - pattern: ^(vlan|vxlan)$)</em><p>Encapsulation</p>
</li>
<li>
<strong>ipv6Gateway</strong>: <em>required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)</em><p>IPv6Gateway</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>ipv6Subnet</strong>: <em>required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)</em><p>IPv6Subnet</p>
</li>
<li>
<strong>gateway</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Gateway</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Network name</p>
</li>
<li>
<strong>subnet</strong>: <em>required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)</em><p>Subnet</p>
</li>
<li>
<strong>nwType</strong>: <em>required (string - pattern: ^(infra|data)$)</em><p>Network Type</p>
</li>
<li>
<strong>cfgdTag</strong>: <em>required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</em><p>Configured Network Tag</p>
</li>
</ul>
</div>
<div class="tab-pane" id="networks__tenantname___networkname__post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="networks__tenantname___networkname__post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="networks__tenantname___networkname__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/networks</span>/{tenantName}:{networkName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a network.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#networks__tenantname___networkname__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#networks__tenantname___networkname__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#networks__tenantname___networkname__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="networks__tenantname___networkname__delete_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>networkName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="networks__tenantname___networkname__delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="networks__tenantname___networkname__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="policys" class="panel-title">Policies</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>A collection of policys</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_policys"><span class="parent"></span>/policys/</a> <span class="methods"><a href="#policys_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_policys" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#policys_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of policys.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="policys_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/policys/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of policys.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#policys_get_response" data-toggle="tab">Response</a></li>
<li><a href="#policys_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="policys_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of policy</p>
<p><strong>Items</strong>: policy</p>
<div class="items"><ul>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="policys_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_policys__tenantname___policyname_"><span class="parent">/policys</span>/{tenantName}:{policyName}/</a> <span class="methods"><a href="#policys__tenantname___policyname__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#policys__tenantname___policyname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#policys__tenantname___policyname__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#policys__tenantname___policyname__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_policys__tenantname___policyname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing policy</p></div>
<div class="list-group">
<div onclick="window.location.href = '#policys__tenantname___policyname__put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a policy</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#policys__tenantname___policyname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a policy.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#policys__tenantname___policyname__post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new policy.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#policys__tenantname___policyname__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a policy.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="policys__tenantname___policyname__put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/policys</span>/{tenantName}:{policyName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a policy</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#policys__tenantname___policyname__put_request" data-toggle="tab">Request</a></li>
<li><a href="#policys__tenantname___policyname__put_response" data-toggle="tab">Response</a></li>
<li><a href="#policys__tenantname___policyname__put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="policys__tenantname___policyname__put_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>policyName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
</ul>
</div>
<div class="tab-pane" id="policys__tenantname___policyname__put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "policy not found" }
</code></pre>
</div>
<div class="tab-pane" id="policys__tenantname___policyname__put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="policys__tenantname___policyname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/policys</span>/{tenantName}:{policyName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a policy.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#policys__tenantname___policyname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#policys__tenantname___policyname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#policys__tenantname___policyname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="policys__tenantname___policyname__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>policyName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="policys__tenantname___policyname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "policy not found" }
</code></pre>
</div>
<div class="tab-pane" id="policys__tenantname___policyname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="policys__tenantname___policyname__post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/policys</span>/{tenantName}:{policyName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new policy.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#policys__tenantname___policyname__post_request" data-toggle="tab">Request</a></li>
<li><a href="#policys__tenantname___policyname__post_response" data-toggle="tab">Response</a></li>
<li><a href="#policys__tenantname___policyname__post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="policys__tenantname___policyname__post_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>policyName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
</ul>
</div>
<div class="tab-pane" id="policys__tenantname___policyname__post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="policys__tenantname___policyname__post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="policys__tenantname___policyname__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/policys</span>/{tenantName}:{policyName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a policy.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#policys__tenantname___policyname__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#policys__tenantname___policyname__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#policys__tenantname___policyname__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="policys__tenantname___policyname__delete_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>policyName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="policys__tenantname___policyname__delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="policys__tenantname___policyname__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="rules" class="panel-title">Rules</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>A collection of rules</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_rules"><span class="parent"></span>/rules/</a> <span class="methods"><a href="#rules_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_rules" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#rules_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of rules.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="rules_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/rules/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of rules.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#rules_get_response" data-toggle="tab">Response</a></li>
<li><a href="#rules_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="rules_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of rule</p>
<p><strong>Items</strong>: rule</p>
<div class="items"><ul>
<li>
<strong>protocol</strong>: <em>required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)</em><p>Protocol</p>
</li>
<li>
<strong>fromEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Endpoint Group</p>
</li>
<li>
<strong>fromIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>toEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Endpoint Group</p>
</li>
<li>
<strong>toIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>toNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Network</p>
</li>
<li>
<strong>port</strong>: <em>required (integer)</em><p>Port No</p>
</li>
<li>
<strong>fromNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Network</p>
</li>
<li>
<strong>ruleId</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Rule Id</p>
</li>
<li>
<strong>priority</strong>: <em>required (integer)</em><p>Priority</p>
</li>
<li>
<strong>action</strong>: <em>required (string - pattern: ^(allow|deny)$)</em><p>Action</p>
</li>
<li>
<strong>direction</strong>: <em>required (string - pattern: ^(in|out)$)</em><p>Direction</p>
</li>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="rules_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_rules__tenantname___policyname___ruleid_"><span class="parent">/rules</span>/{tenantName}:{policyName}:{ruleId}/</a> <span class="methods"><a href="#rules__tenantname___policyname___ruleid__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#rules__tenantname___policyname___ruleid__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#rules__tenantname___policyname___ruleid__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#rules__tenantname___policyname___ruleid__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_rules__tenantname___policyname___ruleid_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing rule</p></div>
<div class="list-group">
<div onclick="window.location.href = '#rules__tenantname___policyname___ruleid__put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a rule</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#rules__tenantname___policyname___ruleid__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a rule.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#rules__tenantname___policyname___ruleid__post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new rule.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#rules__tenantname___policyname___ruleid__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a rule.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="rules__tenantname___policyname___ruleid__put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/rules</span>/{tenantName}:{policyName}:{ruleId}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a rule</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#rules__tenantname___policyname___ruleid__put_request" data-toggle="tab">Request</a></li>
<li><a href="#rules__tenantname___policyname___ruleid__put_response" data-toggle="tab">Response</a></li>
<li><a href="#rules__tenantname___policyname___ruleid__put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="rules__tenantname___policyname___ruleid__put_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>policyName</strong>: <em>required (string)</em>
</li>
<li>
<strong>ruleId</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>protocol</strong>: <em>required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)</em><p>Protocol</p>
</li>
<li>
<strong>fromEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Endpoint Group</p>
</li>
<li>
<strong>fromIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>toEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Endpoint Group</p>
</li>
<li>
<strong>toIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>toNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Network</p>
</li>
<li>
<strong>port</strong>: <em>required (integer)</em><p>Port No</p>
</li>
<li>
<strong>fromNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Network</p>
</li>
<li>
<strong>ruleId</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Rule Id</p>
</li>
<li>
<strong>priority</strong>: <em>required (integer)</em><p>Priority</p>
</li>
<li>
<strong>action</strong>: <em>required (string - pattern: ^(allow|deny)$)</em><p>Action</p>
</li>
<li>
<strong>direction</strong>: <em>required (string - pattern: ^(in|out)$)</em><p>Direction</p>
</li>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
</ul>
</div>
<div class="tab-pane" id="rules__tenantname___policyname___ruleid__put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>protocol</strong>: <em>required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)</em><p>Protocol</p>
</li>
<li>
<strong>fromEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Endpoint Group</p>
</li>
<li>
<strong>fromIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>toEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Endpoint Group</p>
</li>
<li>
<strong>toIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>toNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Network</p>
</li>
<li>
<strong>port</strong>: <em>required (integer)</em><p>Port No</p>
</li>
<li>
<strong>fromNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Network</p>
</li>
<li>
<strong>ruleId</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Rule Id</p>
</li>
<li>
<strong>priority</strong>: <em>required (integer)</em><p>Priority</p>
</li>
<li>
<strong>action</strong>: <em>required (string - pattern: ^(allow|deny)$)</em><p>Action</p>
</li>
<li>
<strong>direction</strong>: <em>required (string - pattern: ^(in|out)$)</em><p>Direction</p>
</li>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "rule not found" }
</code></pre>
</div>
<div class="tab-pane" id="rules__tenantname___policyname___ruleid__put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="rules__tenantname___policyname___ruleid__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/rules</span>/{tenantName}:{policyName}:{ruleId}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a rule.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#rules__tenantname___policyname___ruleid__get_request" data-toggle="tab">Request</a></li>
<li><a href="#rules__tenantname___policyname___ruleid__get_response" data-toggle="tab">Response</a></li>
<li><a href="#rules__tenantname___policyname___ruleid__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="rules__tenantname___policyname___ruleid__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>policyName</strong>: <em>required (string)</em>
</li>
<li>
<strong>ruleId</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="rules__tenantname___policyname___ruleid__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>protocol</strong>: <em>required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)</em><p>Protocol</p>
</li>
<li>
<strong>fromEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Endpoint Group</p>
</li>
<li>
<strong>fromIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>toEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Endpoint Group</p>
</li>
<li>
<strong>toIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>toNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Network</p>
</li>
<li>
<strong>port</strong>: <em>required (integer)</em><p>Port No</p>
</li>
<li>
<strong>fromNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Network</p>
</li>
<li>
<strong>ruleId</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Rule Id</p>
</li>
<li>
<strong>priority</strong>: <em>required (integer)</em><p>Priority</p>
</li>
<li>
<strong>action</strong>: <em>required (string - pattern: ^(allow|deny)$)</em><p>Action</p>
</li>
<li>
<strong>direction</strong>: <em>required (string - pattern: ^(in|out)$)</em><p>Direction</p>
</li>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "rule not found" }
</code></pre>
</div>
<div class="tab-pane" id="rules__tenantname___policyname___ruleid__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="rules__tenantname___policyname___ruleid__post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/rules</span>/{tenantName}:{policyName}:{ruleId}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new rule.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#rules__tenantname___policyname___ruleid__post_request" data-toggle="tab">Request</a></li>
<li><a href="#rules__tenantname___policyname___ruleid__post_response" data-toggle="tab">Response</a></li>
<li><a href="#rules__tenantname___policyname___ruleid__post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="rules__tenantname___policyname___ruleid__post_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>policyName</strong>: <em>required (string)</em>
</li>
<li>
<strong>ruleId</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>protocol</strong>: <em>required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)</em><p>Protocol</p>
</li>
<li>
<strong>fromEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Endpoint Group</p>
</li>
<li>
<strong>fromIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>toEndpointGroup</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Endpoint Group</p>
</li>
<li>
<strong>toIpAddress</strong>: <em>required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)</em><p>IP Address</p>
</li>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>toNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>To Network</p>
</li>
<li>
<strong>port</strong>: <em>required (integer)</em><p>Port No</p>
</li>
<li>
<strong>fromNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>From Network</p>
</li>
<li>
<strong>ruleId</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Rule Id</p>
</li>
<li>
<strong>priority</strong>: <em>required (integer)</em><p>Priority</p>
</li>
<li>
<strong>action</strong>: <em>required (string - pattern: ^(allow|deny)$)</em><p>Action</p>
</li>
<li>
<strong>direction</strong>: <em>required (string - pattern: ^(in|out)$)</em><p>Direction</p>
</li>
<li>
<strong>policyName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Policy Name</p>
</li>
</ul>
</div>
<div class="tab-pane" id="rules__tenantname___policyname___ruleid__post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="rules__tenantname___policyname___ruleid__post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="rules__tenantname___policyname___ruleid__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/rules</span>/{tenantName}:{policyName}:{ruleId}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a rule.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#rules__tenantname___policyname___ruleid__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#rules__tenantname___policyname___ruleid__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#rules__tenantname___policyname___ruleid__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="rules__tenantname___policyname___ruleid__delete_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>policyName</strong>: <em>required (string)</em>
</li>
<li>
<strong>ruleId</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="rules__tenantname___policyname___ruleid__delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="rules__tenantname___policyname___ruleid__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="servicelbs" class="panel-title">Service Load Balancers</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>A collection of serviceLBs</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_servicelbs"><span class="parent"></span>/serviceLBs/</a> <span class="methods"><a href="#servicelbs_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_servicelbs" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#servicelbs_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of serviceLBs.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="servicelbs_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/serviceLBs/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of serviceLBs.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#servicelbs_get_response" data-toggle="tab">Response</a></li>
<li><a href="#servicelbs_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="servicelbs_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of serviceLB</p>
<p><strong>Items</strong>: serviceLB</p>
<div class="items"><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Service network name</p>
</li>
<li>
<strong>serviceName</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>service name</p>
</li>
<li>
<strong>ipAddress</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Service ip</p>
</li>
<li>
<strong>selectors</strong>: <em>required (array of items)</em><p>labels key value pair</p>
</li>
<li>
<strong>ports</strong>: <em>required (array of items)</em><p>service provider port</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="servicelbs_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_servicelbs__tenantname___servicename_"><span class="parent">/serviceLBs</span>/{tenantName}:{serviceName}/</a> <span class="methods"><a href="#servicelbs__tenantname___servicename__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#servicelbs__tenantname___servicename__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#servicelbs__tenantname___servicename__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#servicelbs__tenantname___servicename__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_servicelbs__tenantname___servicename_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing serviceLB</p></div>
<div class="list-group">
<div onclick="window.location.href = '#servicelbs__tenantname___servicename__put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a serviceLB</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#servicelbs__tenantname___servicename__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a serviceLB.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#servicelbs__tenantname___servicename__post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new serviceLB.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#servicelbs__tenantname___servicename__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a serviceLB.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="servicelbs__tenantname___servicename__put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/serviceLBs</span>/{tenantName}:{serviceName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a serviceLB</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#servicelbs__tenantname___servicename__put_request" data-toggle="tab">Request</a></li>
<li><a href="#servicelbs__tenantname___servicename__put_response" data-toggle="tab">Response</a></li>
<li><a href="#servicelbs__tenantname___servicename__put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="servicelbs__tenantname___servicename__put_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>serviceName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: netmaster.serviceLB</p>
</div>
<div class="tab-pane" id="servicelbs__tenantname___servicename__put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Service network name</p>
</li>
<li>
<strong>serviceName</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>service name</p>
</li>
<li>
<strong>ipAddress</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Service ip</p>
</li>
<li>
<strong>selectors</strong>: <em>required (array of items)</em><p>labels key value pair</p>
</li>
<li>
<strong>ports</strong>: <em>required (array of items)</em><p>service provider port</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "serviceLB not found" }
</code></pre>
</div>
<div class="tab-pane" id="servicelbs__tenantname___servicename__put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="servicelbs__tenantname___servicename__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/serviceLBs</span>/{tenantName}:{serviceName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a serviceLB.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#servicelbs__tenantname___servicename__get_request" data-toggle="tab">Request</a></li>
<li><a href="#servicelbs__tenantname___servicename__get_response" data-toggle="tab">Response</a></li>
<li><a href="#servicelbs__tenantname___servicename__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="servicelbs__tenantname___servicename__get_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>serviceName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="servicelbs__tenantname___servicename__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Service network name</p>
</li>
<li>
<strong>serviceName</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>service name</p>
</li>
<li>
<strong>ipAddress</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Service ip</p>
</li>
<li>
<strong>selectors</strong>: <em>required (array of items)</em><p>labels key value pair</p>
</li>
<li>
<strong>ports</strong>: <em>required (array of items)</em><p>service provider port</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "serviceLB not found" }
</code></pre>
</div>
<div class="tab-pane" id="servicelbs__tenantname___servicename__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="servicelbs__tenantname___servicename__post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/serviceLBs</span>/{tenantName}:{serviceName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new serviceLB.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#servicelbs__tenantname___servicename__post_request" data-toggle="tab">Request</a></li>
<li><a href="#servicelbs__tenantname___servicename__post_response" data-toggle="tab">Response</a></li>
<li><a href="#servicelbs__tenantname___servicename__post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="servicelbs__tenantname___servicename__post_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>serviceName</strong>: <em>required (string)</em>
</li>
</ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>networkName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Service network name</p>
</li>
<li>
<strong>serviceName</strong>: <em>required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>service name</p>
</li>
<li>
<strong>ipAddress</strong>: <em>required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)</em><p>Service ip</p>
</li>
<li>
<strong>selectors</strong>: <em>required (array of items)</em><p>labels key value pair</p>
</li>
<li>
<strong>ports</strong>: <em>required (array of items)</em><p>service provider port</p>
</li>
</ul>
</div>
<div class="tab-pane" id="servicelbs__tenantname___servicename__post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="servicelbs__tenantname___servicename__post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="servicelbs__tenantname___servicename__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/serviceLBs</span>/{tenantName}:{serviceName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a serviceLB.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#servicelbs__tenantname___servicename__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#servicelbs__tenantname___servicename__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#servicelbs__tenantname___servicename__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="servicelbs__tenantname___servicename__delete_request">
<h3>URI Parameters</h3>
<ul>
<li>
<strong>tenantName</strong>: <em>required (string)</em>
</li>
<li>
<strong>serviceName</strong>: <em>required (string)</em>
</li>
</ul>
</div>
<div class="tab-pane" id="servicelbs__tenantname___servicename__delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="servicelbs__tenantname___servicename__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h3 id="tenants" class="panel-title">Tenants</h3></div>
<div class="panel-body">
<div class="top-resource-description"><p>A collection of tenants</p></div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_tenants"><span class="parent"></span>/tenants/</a> <span class="methods"><a href="#tenants_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_tenants" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#tenants_get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a list of tenants.</p></div>
<div class="clearfix"></div>
</div></div></div></div>
<div class="modal fade" tabindex="0" id="tenants_get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/tenants/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a list of tenants.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#tenants_get_response" data-toggle="tab">Response</a></li>
<li><a href="#tenants_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="tenants_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: array of tenant</p>
<p><strong>Items</strong>: tenant</p>
<div class="items"><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>defaultNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>Network name</p>
</li>
</ul></div>
</div>
<div class="tab-pane" id="tenants_get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
<div class="panel panel-white resource-modal">
<div class="panel-heading"><h4 class="panel-title">
<a class="collapsed" data-toggle="collapse" href="#panel_tenants__tenantname_"><span class="parent">/tenants</span>/{tenantName}/</a> <span class="methods"><a href="#tenants__tenantname__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#tenants__tenantname__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#tenants__tenantname__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#tenants__tenantname__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span>
</h4></div>
<div id="panel_tenants__tenantname_" class="panel-collapse collapse"><div class="panel-body">
<div class="resource-description"><p>Entity representing tenant</p></div>
<div class="list-group">
<div onclick="window.location.href = '#tenants__tenantname__put'" class="list-group-item">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Updates a tenant</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#tenants__tenantname__get'" class="list-group-item">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a tenant.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#tenants__tenantname__post'" class="list-group-item">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates a new tenant.</p></div>
<div class="clearfix"></div>
</div>
<div onclick="window.location.href = '#tenants__tenantname__delete'" class="list-group-item">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Deletes a tenant.</p></div>
<div class="clearfix"></div>
</div>
</div>
</div></div>
<div class="modal fade" tabindex="0" id="tenants__tenantname__put"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/tenants</span>/{tenantName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Updates a tenant</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#tenants__tenantname__put_request" data-toggle="tab">Request</a></li>
<li><a href="#tenants__tenantname__put_response" data-toggle="tab">Response</a></li>
<li><a href="#tenants__tenantname__put_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="tenants__tenantname__put_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>tenantName</strong>: <em>required (string)</em>
</li></ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>defaultNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>Network name</p>
</li>
</ul>
</div>
<div class="tab-pane" id="tenants__tenantname__put_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>defaultNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>Network name</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "tenant not found" }
</code></pre>
</div>
<div class="tab-pane" id="tenants__tenantname__put_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="tenants__tenantname__get"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/tenants</span>/{tenantName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Returns a tenant.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#tenants__tenantname__get_request" data-toggle="tab">Request</a></li>
<li><a href="#tenants__tenantname__get_response" data-toggle="tab">Response</a></li>
<li><a href="#tenants__tenantname__get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="tenants__tenantname__get_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>tenantName</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="tenants__tenantname__get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>defaultNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>Network name</p>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>:</p>
<pre><code>{"message": "tenant not found" }
</code></pre>
</div>
<div class="tab-pane" id="tenants__tenantname__get_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="tenants__tenantname__post"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/tenants</span>/{tenantName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Creates a new tenant.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#tenants__tenantname__post_request" data-toggle="tab">Request</a></li>
<li><a href="#tenants__tenantname__post_response" data-toggle="tab">Response</a></li>
<li><a href="#tenants__tenantname__post_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="tenants__tenantname__post_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>tenantName</strong>: <em>required (string)</em>
</li></ul>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<strong>Properties</strong><ul>
<li>
<strong>tenantName</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)</em><p>Tenant Name</p>
</li>
<li>
<strong>defaultNetwork</strong>: <em>required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)</em><p>Network name</p>
</li>
</ul>
</div>
<div class="tab-pane" id="tenants__tenantname__post_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="tenants__tenantname__post_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
<div class="modal fade" tabindex="0" id="tenants__tenantname__delete"><div class="modal-dialog"><div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&#215;</button><h4 class="modal-title" id="myModalLabel">
<span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/tenants</span>/{tenantName}/</h4>
</div>
<div class="modal-body">
<div class="alert alert-info"><p>Deletes a tenant.</p></div>
<div class="alert alert-warning">
<span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="#tenants__tenantname__delete_request" data-toggle="tab">Request</a></li>
<li><a href="#tenants__tenantname__delete_response" data-toggle="tab">Response</a></li>
<li><a href="#tenants__tenantname__delete_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="tenants__tenantname__delete_request">
<h3>URI Parameters</h3>
<ul><li>
<strong>tenantName</strong>: <em>required (string)</em>
</li></ul>
</div>
<div class="tab-pane" id="tenants__tenantname__delete_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a>
</h2>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a>
</h2>
</div>
<div class="tab-pane" id="tenants__tenantname__delete_securedby">
<h1>Secured by custom_scheme</h1>
<h3>Headers</h3>
<ul><li>
<strong>X-Auth-Token</strong>: <em>required (string)</em><p>Used to send a custom token. Obtained via /login API.</p>
</li></ul>
</div>
</div>
</div>
</div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked">
<li><a href="#auth_proxy">Auth API</a></li>
<li><a href="#inspect">Inspect</a></li>
<li><a href="#acigws">ACI Gateways</a></li>
<li><a href="#appprofiles">Application Profiles</a></li>
<li><a href="#bgps">BGP</a></li>
<li><a href="#endpointgroups">Endpoint Groups</a></li>
<li><a href="#extcontractsgroups">External Contract Groups</a></li>
<li><a href="#globals">Globals</a></li>
<li><a href="#netprofiles">Network Profiles</a></li>
<li><a href="#networks">Networks</a></li>
<li><a href="#policys">Policies</a></li>
<li><a href="#rules">Rules</a></li>
<li><a href="#servicelbs">Service Load Balancers</a></li>
<li><a href="#tenants">Tenants</a></li>
</ul></div></div>
</div></div>
</body>
</html>
